Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostChargesChargeRefund

Description

Contains the different functions to run the operation postChargesChargeRefund

Synopsis

postChargesChargeRefund :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeRefundRequestBody -> m (Either HttpException (Response PostChargesChargeRefundResponse))
postChargesChargeRefundRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeRefundRequestBody -> m (Either HttpException (Response ByteString))
postChargesChargeRefundM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeRefundResponse))
postChargesChargeRefundRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostChargesChargeRefundRequestBody = PostChargesChargeRefundRequestBody {
}
data PostChargesChargeRefundRequestBodyMetadata' = PostChargesChargeRefundRequestBodyMetadata' {
}
data PostChargesChargeRefundRequestBodyReason'
data PostChargesChargeRefundResponse

Documentation

postChargesChargeRefund Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	charge \| Constraints: Maximum length of 5000
-> Maybe PostChargesChargeRefundRequestBody	The request body to send
-> m (Either HttpException (Response PostChargesChargeRefundResponse))	Monad containing the result of the operation

POST /v1/charges/{charge}/refund

When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

postChargesChargeRefundRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeRefundRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/charges/{charge}/refund

The same as postChargesChargeRefund but returns the raw ByteString

postChargesChargeRefundM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeRefundResponse)) Source #

POST /v1/charges/{charge}/refund

Monadic version of postChargesChargeRefund (use with runWithConfiguration)

postChargesChargeRefundRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/charges/{charge}/refund

Monadic version of postChargesChargeRefundRaw (use with runWithConfiguration)

data PostChargesChargeRefundRequestBody Source #

Defines the data type for the schema postChargesChargeRefundRequestBody

Constructors

PostChargesChargeRefundRequestBody

Fields

postChargesChargeRefundRequestBodyAmount :: Maybe Integer
amount
postChargesChargeRefundRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postChargesChargeRefundRequestBodyMetadata :: Maybe PostChargesChargeRefundRequestBodyMetadata'
metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
postChargesChargeRefundRequestBodyPaymentIntent :: Maybe Text
payment_intent
Constraints:
- Maximum length of 5000
postChargesChargeRefundRequestBodyReason :: Maybe PostChargesChargeRefundRequestBodyReason'
reason
Constraints:
- Maximum length of 5000
postChargesChargeRefundRequestBodyRefundApplicationFee :: Maybe Bool
refund_application_fee
postChargesChargeRefundRequestBodyReverseTransfer :: Maybe Bool
reverse_transfer

Instances

Eq PostChargesChargeRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods (==) :: PostChargesChargeRefundRequestBody -> PostChargesChargeRefundRequestBody -> Bool # (/=) :: PostChargesChargeRefundRequestBody -> PostChargesChargeRefundRequestBody -> Bool #
Show PostChargesChargeRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods showsPrec :: Int -> PostChargesChargeRefundRequestBody -> ShowS # show :: PostChargesChargeRefundRequestBody -> String # showList :: [PostChargesChargeRefundRequestBody] -> ShowS #
ToJSON PostChargesChargeRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods toJSON :: PostChargesChargeRefundRequestBody -> Value # toEncoding :: PostChargesChargeRefundRequestBody -> Encoding # toJSONList :: [PostChargesChargeRefundRequestBody] -> Value # toEncodingList :: [PostChargesChargeRefundRequestBody] -> Encoding #
FromJSON PostChargesChargeRefundRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods parseJSON :: Value -> Parser PostChargesChargeRefundRequestBody # parseJSONList :: Value -> Parser [PostChargesChargeRefundRequestBody] #

data PostChargesChargeRefundRequestBodyMetadata' Source #

Defines the data type for the schema postChargesChargeRefundRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostChargesChargeRefundRequestBodyMetadata'

Instances

Eq PostChargesChargeRefundRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods (==) :: PostChargesChargeRefundRequestBodyMetadata' -> PostChargesChargeRefundRequestBodyMetadata' -> Bool # (/=) :: PostChargesChargeRefundRequestBodyMetadata' -> PostChargesChargeRefundRequestBodyMetadata' -> Bool #
Show PostChargesChargeRefundRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods showsPrec :: Int -> PostChargesChargeRefundRequestBodyMetadata' -> ShowS # show :: PostChargesChargeRefundRequestBodyMetadata' -> String # showList :: [PostChargesChargeRefundRequestBodyMetadata'] -> ShowS #
ToJSON PostChargesChargeRefundRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods toJSON :: PostChargesChargeRefundRequestBodyMetadata' -> Value # toEncoding :: PostChargesChargeRefundRequestBodyMetadata' -> Encoding # toJSONList :: [PostChargesChargeRefundRequestBodyMetadata'] -> Value # toEncodingList :: [PostChargesChargeRefundRequestBodyMetadata'] -> Encoding #
FromJSON PostChargesChargeRefundRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods parseJSON :: Value -> Parser PostChargesChargeRefundRequestBodyMetadata' # parseJSONList :: Value -> Parser [PostChargesChargeRefundRequestBodyMetadata'] #

data PostChargesChargeRefundRequestBodyReason' Source #

Defines the enum schema postChargesChargeRefundRequestBodyReason'

Constructors

PostChargesChargeRefundRequestBodyReason'EnumOther Value
PostChargesChargeRefundRequestBodyReason'EnumTyped Text
PostChargesChargeRefundRequestBodyReason'EnumStringDuplicate
PostChargesChargeRefundRequestBodyReason'EnumStringFraudulent
PostChargesChargeRefundRequestBodyReason'EnumStringRequestedByCustomer

Instances

Eq PostChargesChargeRefundRequestBodyReason' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods (==) :: PostChargesChargeRefundRequestBodyReason' -> PostChargesChargeRefundRequestBodyReason' -> Bool # (/=) :: PostChargesChargeRefundRequestBodyReason' -> PostChargesChargeRefundRequestBodyReason' -> Bool #
Show PostChargesChargeRefundRequestBodyReason' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods showsPrec :: Int -> PostChargesChargeRefundRequestBodyReason' -> ShowS # show :: PostChargesChargeRefundRequestBodyReason' -> String # showList :: [PostChargesChargeRefundRequestBodyReason'] -> ShowS #
ToJSON PostChargesChargeRefundRequestBodyReason' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods toJSON :: PostChargesChargeRefundRequestBodyReason' -> Value # toEncoding :: PostChargesChargeRefundRequestBodyReason' -> Encoding # toJSONList :: [PostChargesChargeRefundRequestBodyReason'] -> Value # toEncodingList :: [PostChargesChargeRefundRequestBodyReason'] -> Encoding #
FromJSON PostChargesChargeRefundRequestBodyReason' Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods parseJSON :: Value -> Parser PostChargesChargeRefundRequestBodyReason' # parseJSONList :: Value -> Parser [PostChargesChargeRefundRequestBodyReason'] #

data PostChargesChargeRefundResponse Source #

Represents a response of the operation postChargesChargeRefund.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostChargesChargeRefundResponseError is used.

Constructors

PostChargesChargeRefundResponseError String	Means either no matching case available or a parse error
PostChargesChargeRefundResponse200 Charge	Successful response.
PostChargesChargeRefundResponseDefault Error	Error response.

Instances

Eq PostChargesChargeRefundResponse Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods (==) :: PostChargesChargeRefundResponse -> PostChargesChargeRefundResponse -> Bool # (/=) :: PostChargesChargeRefundResponse -> PostChargesChargeRefundResponse -> Bool #
Show PostChargesChargeRefundResponse Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeRefund Methods showsPrec :: Int -> PostChargesChargeRefundResponse -> ShowS # show :: PostChargesChargeRefundResponse -> String # showList :: [PostChargesChargeRefundResponse] -> ShowS #