StripeAPI.Operations.PostTransfersIdReversals

Contains the different functions to run the operation postTransfersIdReversals

Documentation

postTransfersIdReversals

Arguments

:: forall m. MonadHTTP m

=> Text

id | Constraints: Maximum length of 5000

-> Maybe PostTransfersIdReversalsRequestBody

The request body to send

-> ClientT m (Response PostTransfersIdReversalsResponse)

Monadic computation which returns the result of the operation

POST /v1/transfers/{id}/reversals

<p>When you create a new reversal, you must specify a transfer to create it on.</p>

<p>When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.</p>

<p>Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.</p>

data PostTransfersIdReversalsRequestBody

Defines the object schema located at paths./v1/transfers/{id}/reversals.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTransfersIdReversalsRequestBody

Fields

• postTransfersIdReversalsRequestBodyAmount :: Maybe Int

  amount: A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.

• postTransfersIdReversalsRequestBodyDescription :: Maybe Text

  description: An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value.

  Constraints:

  • Maximum length of 5000
• postTransfersIdReversalsRequestBodyExpand :: Maybe [Text]

  expand: Specifies which fields in the response should be expanded.

• postTransfersIdReversalsRequestBodyMetadata :: Maybe PostTransfersIdReversalsRequestBodyMetadata'Variants

  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`.

• postTransfersIdReversalsRequestBodyRefundApplicationFee :: Maybe Bool

  refund_application_fee: Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.

Instances

Eq PostTransfersIdReversalsRequestBody

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

(==) :: PostTransfersIdReversalsRequestBody -> PostTransfersIdReversalsRequestBody -> Bool

(/=) :: PostTransfersIdReversalsRequestBody -> PostTransfersIdReversalsRequestBody -> Bool

Show PostTransfersIdReversalsRequestBody

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

showsPrec :: Int -> PostTransfersIdReversalsRequestBody -> ShowS

show :: PostTransfersIdReversalsRequestBody -> String

showList :: [PostTransfersIdReversalsRequestBody] -> ShowS

ToJSON PostTransfersIdReversalsRequestBody

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

toJSON :: PostTransfersIdReversalsRequestBody -> Value

toEncoding :: PostTransfersIdReversalsRequestBody -> Encoding

toJSONList :: [PostTransfersIdReversalsRequestBody] -> Value

toEncodingList :: [PostTransfersIdReversalsRequestBody] -> Encoding

FromJSON PostTransfersIdReversalsRequestBody

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

parseJSON :: Value -> Parser PostTransfersIdReversalsRequestBody

parseJSONList :: Value -> Parser [PostTransfersIdReversalsRequestBody]

mkPostTransfersIdReversalsRequestBody :: PostTransfersIdReversalsRequestBody

Create a new PostTransfersIdReversalsRequestBody with all required fields.

data PostTransfersIdReversalsRequestBodyMetadata'Variants

Defines the oneOf schema located at paths./v1/transfers/{id}/reversals.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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

PostTransfersIdReversalsRequestBodyMetadata'EmptyString

Represents the JSON value ""

PostTransfersIdReversalsRequestBodyMetadata'Object Object

Instances

Eq PostTransfersIdReversalsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

(==) :: PostTransfersIdReversalsRequestBodyMetadata'Variants -> PostTransfersIdReversalsRequestBodyMetadata'Variants -> Bool

(/=) :: PostTransfersIdReversalsRequestBodyMetadata'Variants -> PostTransfersIdReversalsRequestBodyMetadata'Variants -> Bool

Show PostTransfersIdReversalsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

showsPrec :: Int -> PostTransfersIdReversalsRequestBodyMetadata'Variants -> ShowS

show :: PostTransfersIdReversalsRequestBodyMetadata'Variants -> String

showList :: [PostTransfersIdReversalsRequestBodyMetadata'Variants] -> ShowS

ToJSON PostTransfersIdReversalsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

toJSON :: PostTransfersIdReversalsRequestBodyMetadata'Variants -> Value

toEncoding :: PostTransfersIdReversalsRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostTransfersIdReversalsRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostTransfersIdReversalsRequestBodyMetadata'Variants] -> Encoding

FromJSON PostTransfersIdReversalsRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

parseJSON :: Value -> Parser PostTransfersIdReversalsRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostTransfersIdReversalsRequestBodyMetadata'Variants]

data PostTransfersIdReversalsResponse

Represents a response of the operation postTransfersIdReversals.

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), PostTransfersIdReversalsResponseError is used.

Constructors

PostTransfersIdReversalsResponseError String

Means either no matching case available or a parse error

PostTransfersIdReversalsResponse200 TransferReversal

Successful response.

PostTransfersIdReversalsResponseDefault Error

Error response.

Instances

Eq PostTransfersIdReversalsResponse

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

(==) :: PostTransfersIdReversalsResponse -> PostTransfersIdReversalsResponse -> Bool

(/=) :: PostTransfersIdReversalsResponse -> PostTransfersIdReversalsResponse -> Bool

Show PostTransfersIdReversalsResponse

Defined in StripeAPI.Operations.PostTransfersIdReversals

Methods

showsPrec :: Int -> PostTransfersIdReversalsResponse -> ShowS

show :: PostTransfersIdReversalsResponse -> String

showList :: [PostTransfersIdReversalsResponse] -> ShowS