Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Operations.PostPayoutsPayout
Description
Contains the different functions to run the operation postPayoutsPayout
Synopsis
- postPayoutsPayout :: forall m. MonadHTTP m => Text -> Maybe PostPayoutsPayoutRequestBody -> ClientT m (Response PostPayoutsPayoutResponse)
- data PostPayoutsPayoutRequestBody = PostPayoutsPayoutRequestBody {}
- mkPostPayoutsPayoutRequestBody :: PostPayoutsPayoutRequestBody
- data PostPayoutsPayoutRequestBodyMetadata'Variants
- data PostPayoutsPayoutResponse
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> Text | payout | Constraints: Maximum length of 5000 |
-> Maybe PostPayoutsPayoutRequestBody | The request body to send |
-> ClientT m (Response PostPayoutsPayoutResponse) | Monadic computation which returns the result of the operation |
POST /v1/payouts/{payout}
<p>Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.</p>
data PostPayoutsPayoutRequestBody Source #
Defines the object schema located at paths./v1/payouts/{payout}.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
Constructors
PostPayoutsPayoutRequestBody | |
Fields
|
Instances
mkPostPayoutsPayoutRequestBody :: PostPayoutsPayoutRequestBody Source #
Create a new PostPayoutsPayoutRequestBody
with all required fields.
data PostPayoutsPayoutRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/payouts/{payout}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf
in the specification.
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
PostPayoutsPayoutRequestBodyMetadata'EmptyString | Represents the JSON value |
PostPayoutsPayoutRequestBodyMetadata'Object Object |
Instances
data PostPayoutsPayoutResponse Source #
Represents a response of the operation postPayoutsPayout
.
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), PostPayoutsPayoutResponseError
is used.
Constructors
PostPayoutsPayoutResponseError String | Means either no matching case available or a parse error |
PostPayoutsPayoutResponse200 Payout | Successful response. |
PostPayoutsPayoutResponseDefault Error | Error response. |
Instances
Eq PostPayoutsPayoutResponse Source # | |
Defined in StripeAPI.Operations.PostPayoutsPayout Methods (==) :: PostPayoutsPayoutResponse -> PostPayoutsPayoutResponse -> Bool # (/=) :: PostPayoutsPayoutResponse -> PostPayoutsPayoutResponse -> Bool # | |
Show PostPayoutsPayoutResponse Source # | |
Defined in StripeAPI.Operations.PostPayoutsPayout Methods showsPrec :: Int -> PostPayoutsPayoutResponse -> ShowS # show :: PostPayoutsPayoutResponse -> String # showList :: [PostPayoutsPayoutResponse] -> ShowS # |