StripeAPI.Operations.PostPayoutsPayout

Contains the different functions to run the operation postPayoutsPayout

Documentation

postPayoutsPayout

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

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

• postPayoutsPayoutRequestBodyExpand :: Maybe [Text]

  expand: Specifies which fields in the response should be expanded.

• postPayoutsPayoutRequestBodyMetadata :: Maybe PostPayoutsPayoutRequestBodyMetadata'Variants

  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`.

Instances

Eq PostPayoutsPayoutRequestBody

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

(==) :: PostPayoutsPayoutRequestBody -> PostPayoutsPayoutRequestBody -> Bool

(/=) :: PostPayoutsPayoutRequestBody -> PostPayoutsPayoutRequestBody -> Bool

Show PostPayoutsPayoutRequestBody

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

showsPrec :: Int -> PostPayoutsPayoutRequestBody -> ShowS

show :: PostPayoutsPayoutRequestBody -> String

showList :: [PostPayoutsPayoutRequestBody] -> ShowS

ToJSON PostPayoutsPayoutRequestBody

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

toJSON :: PostPayoutsPayoutRequestBody -> Value

toEncoding :: PostPayoutsPayoutRequestBody -> Encoding

toJSONList :: [PostPayoutsPayoutRequestBody] -> Value

toEncodingList :: [PostPayoutsPayoutRequestBody] -> Encoding

FromJSON PostPayoutsPayoutRequestBody

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

parseJSON :: Value -> Parser PostPayoutsPayoutRequestBody

parseJSONList :: Value -> Parser [PostPayoutsPayoutRequestBody]

mkPostPayoutsPayoutRequestBody :: PostPayoutsPayoutRequestBody

Create a new PostPayoutsPayoutRequestBody with all required fields.

data PostPayoutsPayoutRequestBodyMetadata'Variants

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

Eq PostPayoutsPayoutRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

(==) :: PostPayoutsPayoutRequestBodyMetadata'Variants -> PostPayoutsPayoutRequestBodyMetadata'Variants -> Bool

(/=) :: PostPayoutsPayoutRequestBodyMetadata'Variants -> PostPayoutsPayoutRequestBodyMetadata'Variants -> Bool

Show PostPayoutsPayoutRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

showsPrec :: Int -> PostPayoutsPayoutRequestBodyMetadata'Variants -> ShowS

show :: PostPayoutsPayoutRequestBodyMetadata'Variants -> String

showList :: [PostPayoutsPayoutRequestBodyMetadata'Variants] -> ShowS

ToJSON PostPayoutsPayoutRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

toJSON :: PostPayoutsPayoutRequestBodyMetadata'Variants -> Value

toEncoding :: PostPayoutsPayoutRequestBodyMetadata'Variants -> Encoding

toJSONList :: [PostPayoutsPayoutRequestBodyMetadata'Variants] -> Value

toEncodingList :: [PostPayoutsPayoutRequestBodyMetadata'Variants] -> Encoding

FromJSON PostPayoutsPayoutRequestBodyMetadata'Variants

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

parseJSON :: Value -> Parser PostPayoutsPayoutRequestBodyMetadata'Variants

parseJSONList :: Value -> Parser [PostPayoutsPayoutRequestBodyMetadata'Variants]

data PostPayoutsPayoutResponse

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

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

(==) :: PostPayoutsPayoutResponse -> PostPayoutsPayoutResponse -> Bool

(/=) :: PostPayoutsPayoutResponse -> PostPayoutsPayoutResponse -> Bool

Show PostPayoutsPayoutResponse

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

showsPrec :: Int -> PostPayoutsPayoutResponse -> ShowS

show :: PostPayoutsPayoutResponse -> String

showList :: [PostPayoutsPayoutResponse] -> ShowS