| 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 -> String -> PostChargesChargeRefundRequestBody -> m (Either HttpException (Response PostChargesChargeRefundResponse))
- postChargesChargeRefundRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostChargesChargeRefundRequestBody -> m (Either HttpException (Response ByteString))
- postChargesChargeRefundM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeRefundResponse))
- postChargesChargeRefundRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostChargesChargeRefundRequestBody = PostChargesChargeRefundRequestBody {
- postChargesChargeRefundRequestBodyAmount :: Maybe Integer
- postChargesChargeRefundRequestBodyExpand :: Maybe ([] String)
- postChargesChargeRefundRequestBodyMetadata :: Maybe PostChargesChargeRefundRequestBodyMetadata'
- postChargesChargeRefundRequestBodyPaymentIntent :: Maybe String
- postChargesChargeRefundRequestBodyReason :: Maybe PostChargesChargeRefundRequestBodyReason'
- postChargesChargeRefundRequestBodyRefundApplicationFee :: Maybe Bool
- postChargesChargeRefundRequestBodyReverseTransfer :: Maybe Bool
- data PostChargesChargeRefundRequestBodyMetadata' = PostChargesChargeRefundRequestBodyMetadata' {
- data PostChargesChargeRefundRequestBodyReason'
- = PostChargesChargeRefundRequestBodyReason'EnumOther Value
- | PostChargesChargeRefundRequestBodyReason'EnumTyped String
- | PostChargesChargeRefundRequestBodyReason'EnumStringDuplicate
- | PostChargesChargeRefundRequestBodyReason'EnumStringFraudulent
- | PostChargesChargeRefundRequestBodyReason'EnumStringRequestedByCustomer
- data PostChargesChargeRefundResponse
Documentation
postChargesChargeRefund Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | charge | Constraints: Maximum length of 5000 |
| -> PostChargesChargeRefundRequestBody | The request body to send |
| -> m (Either HttpException (Response PostChargesChargeRefundResponse)) | Monad containing the result of the operation |
POST /v1/charges/{charge}/refund<p>When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.</p>
<p>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.</p>
<p>You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.</p>
<p>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.</p>
postChargesChargeRefundRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostChargesChargeRefundRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/charges/{charge}/refundThe same as postChargesChargeRefund but returns the raw ByteString
postChargesChargeRefundM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeRefundResponse)) Source #
POST /v1/charges/{charge}/refundMonadic version of postChargesChargeRefund (use with runWithConfiguration)
postChargesChargeRefundRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRefundRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/charges/{charge}/refundMonadic version of postChargesChargeRefundRaw (use with runWithConfiguration)
data PostChargesChargeRefundRequestBody Source #
Defines the data type for the schema postChargesChargeRefundRequestBody
Constructors
| PostChargesChargeRefundRequestBody | |
Fields
| |
Instances
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
data PostChargesChargeRefundRequestBodyReason' Source #
Defines the enum schema postChargesChargeRefundRequestBodyReason'
Constructors
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. |