StripeAPI.Operations.PostTransfersTransferReversalsId

Contains the different functions to run the operation postTransfersTransferReversalsId

Documentation

postTransfersTransferReversalsId

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> String

id | Constraints: Maximum length of 5000

-> String

transfer | Constraints: Maximum length of 5000

-> PostTransfersTransferReversalsIdRequestBody

The request body to send

-> m (Either HttpException (Response PostTransfersTransferReversalsIdResponse))

Monad containing the result of the operation

POST /v1/transfers/{transfer}/reversals/{id}

<p>Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

<p>This request only accepts metadata and description as arguments.</p>

postTransfersTransferReversalsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> String -> PostTransfersTransferReversalsIdRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/transfers/{transfer}/reversals/{id}

The same as postTransfersTransferReversalsId but returns the raw ByteString

postTransfersTransferReversalsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> String -> PostTransfersTransferReversalsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostTransfersTransferReversalsIdResponse))

POST /v1/transfers/{transfer}/reversals/{id}

Monadic version of postTransfersTransferReversalsId (use with runWithConfiguration)

postTransfersTransferReversalsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> String -> PostTransfersTransferReversalsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

POST /v1/transfers/{transfer}/reversals/{id}

Monadic version of postTransfersTransferReversalsIdRaw (use with runWithConfiguration)

data PostTransfersTransferReversalsIdRequestBody

Defines the data type for the schema postTransfersTransferReversalsIdRequestBody

Constructors

PostTransfersTransferReversalsIdRequestBody

Fields

• postTransfersTransferReversalsIdRequestBodyExpand :: Maybe ([] String)

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

• postTransfersTransferReversalsIdRequestBodyMetadata :: Maybe PostTransfersTransferReversalsIdRequestBodyMetadata'

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

Instances

Eq PostTransfersTransferReversalsIdRequestBody

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

(==) :: PostTransfersTransferReversalsIdRequestBody -> PostTransfersTransferReversalsIdRequestBody -> Bool

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

Show PostTransfersTransferReversalsIdRequestBody

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

showsPrec :: Int -> PostTransfersTransferReversalsIdRequestBody -> ShowS

show :: PostTransfersTransferReversalsIdRequestBody -> String

showList :: [PostTransfersTransferReversalsIdRequestBody] -> ShowS

ToJSON PostTransfersTransferReversalsIdRequestBody

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

toJSON :: PostTransfersTransferReversalsIdRequestBody -> Value

toEncoding :: PostTransfersTransferReversalsIdRequestBody -> Encoding

toJSONList :: [PostTransfersTransferReversalsIdRequestBody] -> Value

toEncodingList :: [PostTransfersTransferReversalsIdRequestBody] -> Encoding

FromJSON PostTransfersTransferReversalsIdRequestBody

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

parseJSON :: Value -> Parser PostTransfersTransferReversalsIdRequestBody

parseJSONList :: Value -> Parser [PostTransfersTransferReversalsIdRequestBody]

data PostTransfersTransferReversalsIdRequestBodyMetadata'

Defines the data type for the schema postTransfersTransferReversalsIdRequestBodyMetadata'

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

PostTransfersTransferReversalsIdRequestBodyMetadata'

Instances

Eq PostTransfersTransferReversalsIdRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

(==) :: PostTransfersTransferReversalsIdRequestBodyMetadata' -> PostTransfersTransferReversalsIdRequestBodyMetadata' -> Bool

(/=) :: PostTransfersTransferReversalsIdRequestBodyMetadata' -> PostTransfersTransferReversalsIdRequestBodyMetadata' -> Bool

Show PostTransfersTransferReversalsIdRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

showsPrec :: Int -> PostTransfersTransferReversalsIdRequestBodyMetadata' -> ShowS

show :: PostTransfersTransferReversalsIdRequestBodyMetadata' -> String

showList :: [PostTransfersTransferReversalsIdRequestBodyMetadata'] -> ShowS

ToJSON PostTransfersTransferReversalsIdRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

toJSON :: PostTransfersTransferReversalsIdRequestBodyMetadata' -> Value

toEncoding :: PostTransfersTransferReversalsIdRequestBodyMetadata' -> Encoding

toJSONList :: [PostTransfersTransferReversalsIdRequestBodyMetadata'] -> Value

toEncodingList :: [PostTransfersTransferReversalsIdRequestBodyMetadata'] -> Encoding

FromJSON PostTransfersTransferReversalsIdRequestBodyMetadata'

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

parseJSON :: Value -> Parser PostTransfersTransferReversalsIdRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostTransfersTransferReversalsIdRequestBodyMetadata']

data PostTransfersTransferReversalsIdResponse

Represents a response of the operation postTransfersTransferReversalsId.

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

Constructors

PostTransfersTransferReversalsIdResponseError String

Means either no matching case available or a parse error

PostTransfersTransferReversalsIdResponse200 TransferReversal

Successful response.

PostTransfersTransferReversalsIdResponseDefault Error

Error response.

Instances

Eq PostTransfersTransferReversalsIdResponse

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

(==) :: PostTransfersTransferReversalsIdResponse -> PostTransfersTransferReversalsIdResponse -> Bool

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

Show PostTransfersTransferReversalsIdResponse

Defined in StripeAPI.Operations.PostTransfersTransferReversalsId

Methods

showsPrec :: Int -> PostTransfersTransferReversalsIdResponse -> ShowS

show :: PostTransfersTransferReversalsIdResponse -> String

showList :: [PostTransfersTransferReversalsIdResponse] -> ShowS