StripeAPI.Operations.PostPayoutsPayout

Contains the different functions to run the operation postPayoutsPayout

Documentation

postPayoutsPayout

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Text

payout | Constraints: Maximum length of 5000

-> Maybe 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 -> Text -> Maybe PostPayoutsPayoutRequestBody -> m (Either HttpException (Response ByteString))

POST /v1/payouts/{payout}

The same as postPayoutsPayout but returns the raw ByteString

postPayoutsPayoutM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPayoutsPayoutRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPayoutsPayoutResponse))

POST /v1/payouts/{payout}

Monadic version of postPayoutsPayout (use with runWithConfiguration)

postPayoutsPayoutRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPayoutsPayoutRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

POST /v1/payouts/{payout}

Monadic version of postPayoutsPayoutRaw (use with runWithConfiguration)

data PostPayoutsPayoutRequestBody

Defines the data type for the schema postPayoutsPayoutRequestBody

Constructors

PostPayoutsPayoutRequestBody

Fields

• postPayoutsPayoutRequestBodyExpand :: Maybe ([] Text)

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

• postPayoutsPayoutRequestBodyMetadata :: Maybe PostPayoutsPayoutRequestBodyMetadata'

  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]

data PostPayoutsPayoutRequestBodyMetadata'

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

Constructors

PostPayoutsPayoutRequestBodyMetadata'

Instances

Eq PostPayoutsPayoutRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

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

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

Show PostPayoutsPayoutRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

showsPrec :: Int -> PostPayoutsPayoutRequestBodyMetadata' -> ShowS

show :: PostPayoutsPayoutRequestBodyMetadata' -> String

showList :: [PostPayoutsPayoutRequestBodyMetadata'] -> ShowS

ToJSON PostPayoutsPayoutRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

toJSON :: PostPayoutsPayoutRequestBodyMetadata' -> Value

toEncoding :: PostPayoutsPayoutRequestBodyMetadata' -> Encoding

toJSONList :: [PostPayoutsPayoutRequestBodyMetadata'] -> Value

toEncodingList :: [PostPayoutsPayoutRequestBodyMetadata'] -> Encoding

FromJSON PostPayoutsPayoutRequestBodyMetadata'

Defined in StripeAPI.Operations.PostPayoutsPayout

Methods

parseJSON :: Value -> Parser PostPayoutsPayoutRequestBodyMetadata'

parseJSONList :: Value -> Parser [PostPayoutsPayoutRequestBodyMetadata']

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