stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostPayoutsPayout

Description

Contains the different functions to run the operation postPayoutsPayout

Synopsis

Documentation

postPayoutsPayout Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

payout | Constraints: Maximum length of 5000

-> PostPayoutsPayoutRequestBody

The request body to send

-> m (Either HttpException (Response PostPayoutsPayoutResponse))

Monad containing 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>

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

POST /v1/payouts/{payout}

The same as postPayoutsPayout but returns the raw ByteString

data PostPayoutsPayoutRequestBody Source #

Defines the data type for the schema postPayoutsPayoutRequestBody

Constructors

PostPayoutsPayoutRequestBody 

Fields

data PostPayoutsPayoutRequestBodyMetadata' Source #

Defines the data type for the schema postPayoutsPayoutRequestBodyMetadata'

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

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.