stripeapi-2.0.1.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostPayoutsPayoutCancel

Description

Contains the different functions to run the operation postPayoutsPayoutCancel

Synopsis

Documentation

postPayoutsPayoutCancel Source #

Arguments

:: forall m. 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>

data PostPayoutsPayoutCancelRequestBody Source #

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 

Fields

data PostPayoutsPayoutCancelResponse Source #

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.