Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostPayoutsPayoutCancel

Description

Contains the different functions to run the operation postPayoutsPayoutCancel

Synopsis

postPayoutsPayoutCancel :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostPayoutsPayoutCancelRequestBody -> m (Either HttpException (Response PostPayoutsPayoutCancelResponse))
postPayoutsPayoutCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostPayoutsPayoutCancelRequestBody -> m (Either HttpException (Response ByteString))
postPayoutsPayoutCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPayoutsPayoutCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPayoutsPayoutCancelResponse))
postPayoutsPayoutCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPayoutsPayoutCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostPayoutsPayoutCancelRequestBody = PostPayoutsPayoutCancelRequestBody {
- postPayoutsPayoutCancelRequestBodyExpand :: Maybe ([] String)
}
data PostPayoutsPayoutCancelResponse

Documentation

postPayoutsPayoutCancel Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> String	payout \| Constraints: Maximum length of 5000
-> PostPayoutsPayoutCancelRequestBody	The request body to send
-> m (Either HttpException (Response PostPayoutsPayoutCancelResponse))	Monad containing 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>

postPayoutsPayoutCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostPayoutsPayoutCancelRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/payouts/{payout}/cancel

The same as postPayoutsPayoutCancel but returns the raw ByteString

postPayoutsPayoutCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPayoutsPayoutCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPayoutsPayoutCancelResponse)) Source #

POST /v1/payouts/{payout}/cancel

Monadic version of postPayoutsPayoutCancel (use with runWithConfiguration)

postPayoutsPayoutCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPayoutsPayoutCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/payouts/{payout}/cancel

Monadic version of postPayoutsPayoutCancelRaw (use with runWithConfiguration)

data PostPayoutsPayoutCancelRequestBody Source #

Defines the data type for the schema postPayoutsPayoutCancelRequestBody

Constructors

PostPayoutsPayoutCancelRequestBody
Fields postPayoutsPayoutCancelRequestBodyExpand :: Maybe ([] String) expand: Specifies which fields in the response should be expanded.

Instances

Eq PostPayoutsPayoutCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPayoutsPayoutCancel Methods (==) :: PostPayoutsPayoutCancelRequestBody -> PostPayoutsPayoutCancelRequestBody -> Bool # (/=) :: PostPayoutsPayoutCancelRequestBody -> PostPayoutsPayoutCancelRequestBody -> Bool #
Show PostPayoutsPayoutCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPayoutsPayoutCancel Methods showsPrec :: Int -> PostPayoutsPayoutCancelRequestBody -> ShowS # show :: PostPayoutsPayoutCancelRequestBody -> String # showList :: [PostPayoutsPayoutCancelRequestBody] -> ShowS #
ToJSON PostPayoutsPayoutCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPayoutsPayoutCancel Methods toJSON :: PostPayoutsPayoutCancelRequestBody -> Value # toEncoding :: PostPayoutsPayoutCancelRequestBody -> Encoding # toJSONList :: [PostPayoutsPayoutCancelRequestBody] -> Value # toEncodingList :: [PostPayoutsPayoutCancelRequestBody] -> Encoding #
FromJSON PostPayoutsPayoutCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPayoutsPayoutCancel Methods parseJSON :: Value -> Parser PostPayoutsPayoutCancelRequestBody # parseJSONList :: Value -> Parser [PostPayoutsPayoutCancelRequestBody] #

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.

Instances

Eq PostPayoutsPayoutCancelResponse Source #
Instance details Defined in StripeAPI.Operations.PostPayoutsPayoutCancel Methods (==) :: PostPayoutsPayoutCancelResponse -> PostPayoutsPayoutCancelResponse -> Bool # (/=) :: PostPayoutsPayoutCancelResponse -> PostPayoutsPayoutCancelResponse -> Bool #
Show PostPayoutsPayoutCancelResponse Source #
Instance details Defined in StripeAPI.Operations.PostPayoutsPayoutCancel Methods showsPrec :: Int -> PostPayoutsPayoutCancelResponse -> ShowS # show :: PostPayoutsPayoutCancelResponse -> String # showList :: [PostPayoutsPayoutCancelResponse] -> ShowS #