Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostTreasuryCreditReversals

Contains the different functions to run the operation postTreasuryCreditReversals

Synopsis

value postTreasuryCreditReversals
data PostTreasuryCreditReversalsRequestBody
value mkPostTreasuryCreditReversalsRequestBody
data PostTreasuryCreditReversalsResponse

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostTreasuryCreditReversals.hs

valuepostTreasuryCreditReversals

:: MonadHTTP m
=> PostTreasuryCreditReversalsRequestBody
The request body to send
-> ClientT m (Response PostTreasuryCreditReversalsResponse)
Monadic computation which returns the result of the operation

POST /v1/treasury/credit_reversals

<p>Reverses a ReceivedCredit and creates a CreditReversal object.</p>

datadata PostTreasuryCreditReversalsRequestBody

Source#

Defines the object schema located at paths./v1/treasury/credit_reversals.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTreasuryCreditReversalsRequestBody
- postTreasuryCreditReversalsRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postTreasuryCreditReversalsRequestBodyMetadata :: Maybe Object
  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`.
- postTreasuryCreditReversalsRequestBodyReceivedCredit :: Text
  received_credit: The ReceivedCredit to reverse.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTreasuryCreditReversalsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryCreditReversals
Show PostTreasuryCreditReversalsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryCreditReversals
FromJSON PostTreasuryCreditReversalsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryCreditReversals
ToJSON PostTreasuryCreditReversalsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryCreditReversals

valuemkPostTreasuryCreditReversalsRequestBody

:: Text
postTreasuryCreditReversalsRequestBodyReceivedCredit
-> PostTreasuryCreditReversalsRequestBody

Source#

Create a new PostTreasuryCreditReversalsRequestBody with all required fields.

datadata PostTreasuryCreditReversalsResponse

Source#

Represents a response of the operation postTreasuryCreditReversals.

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

Constructors

PostTreasuryCreditReversalsResponseError String
Means either no matching case available or a parse error
PostTreasuryCreditReversalsResponse200 Treasury'creditReversal
Successful response.
PostTreasuryCreditReversalsResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostTreasuryCreditReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryCreditReversals
Show PostTreasuryCreditReversalsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTreasuryCreditReversals