Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostPayoutsPayoutCancel

Contains the different functions to run the operation postPayoutsPayoutCancel

2 types
2 values

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostPayoutsPayoutCancel.hs

valuepostPayoutsPayoutCancel

:: MonadHTTP m
=> Text
payout | Constraints: Maximum length of 5000
-> Maybe PostPayoutsPayoutCancelRequestBody
The request body to send
-> ClientT m (Response PostPayoutsPayoutCancelResponse)
Monadic computation which returns the result of the operation

POST /v1/payouts/{payout}/cancel

<p>A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.</p>

datadata PostPayoutsPayoutCancelRequestBody

Defines the object schema located at paths./v1/payouts/{payout}/cancel.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostPayoutsPayoutCancelRequestBody
- postPayoutsPayoutCancelRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostPayoutsPayoutCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPayoutsPayoutCancel
Show PostPayoutsPayoutCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPayoutsPayoutCancel
FromJSON PostPayoutsPayoutCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPayoutsPayoutCancel
ToJSON PostPayoutsPayoutCancelRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPayoutsPayoutCancel

valuemkPostPayoutsPayoutCancelRequestBody :: PostPayoutsPayoutCancelRequestBody

Create a new PostPayoutsPayoutCancelRequestBody with all required fields.

datadata PostPayoutsPayoutCancelResponse

Represents a response of the operation postPayoutsPayoutCancel.

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

Constructors

PostPayoutsPayoutCancelResponseError String
Means either no matching case available or a parse error
PostPayoutsPayoutCancelResponse200 Payout
Successful response.
PostPayoutsPayoutCancelResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostPayoutsPayoutCancelResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPayoutsPayoutCancel
Show PostPayoutsPayoutCancelResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostPayoutsPayoutCancel