stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostTransfersIdReversals

Description

Contains the different functions to run the operation postTransfersIdReversals

Synopsis

Documentation

postTransfersIdReversals Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> PostTransfersIdReversalsRequestBody

The request body to send

-> m (Either HttpException (Response PostTransfersIdReversalsResponse))

Monad containing 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 Source #

Defines the data type for the schema postTransfersIdReversalsRequestBody

Constructors

PostTransfersIdReversalsRequestBody 

Fields

data PostTransfersIdReversalsRequestBodyMetadata' Source #

Defines the data type for the schema postTransfersIdReversalsRequestBodyMetadata'

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

data PostTransfersIdReversalsResponse Source #

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.