StripeAPI.Operations.PostPayouts

Contains the different functions to run the operation postPayouts

Documentation

postPayouts

Arguments

:: forall m. MonadHTTP m

=> PostPayoutsRequestBody

The request body to send

-> StripeT m (Response PostPayoutsResponse)

Monadic computation which returns the result of the operation

POST /v1/payouts

<p>To send funds to your own bank account, you create a new payout object. Your <a href="#balance">Stripe balance</a> must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.</p>

<p>If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.</p>

<p>If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The <a href="#balance_object">balance object</a> details available and pending amounts by source type.</p>

data PostPayoutsRequestBody

Defines the object schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostPayoutsRequestBody

Fields

• postPayoutsRequestBodyAmount :: Int

  amount: A positive integer in cents representing how much to payout.

• postPayoutsRequestBodyCurrency :: Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• postPayoutsRequestBodyDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• postPayoutsRequestBodyDestination :: Maybe Text

  destination: The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.

• postPayoutsRequestBodyExpand :: Maybe [Text]

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

• postPayoutsRequestBodyMetadata :: Maybe Object

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

• postPayoutsRequestBodyMethod :: Maybe PostPayoutsRequestBodyMethod'

  method: The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)

  Constraints:

  • Maximum length of 5000
• postPayoutsRequestBodySourceType :: Maybe PostPayoutsRequestBodySourceType'

  source_type: The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`.

  Constraints:

  • Maximum length of 5000
• postPayoutsRequestBodyStatementDescriptor :: Maybe Text

  statement_descriptor: A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.

  Constraints:

  • Maximum length of 22

Instances

Eq PostPayoutsRequestBody

Defined in StripeAPI.Operations.PostPayouts

Methods

(==) :: PostPayoutsRequestBody -> PostPayoutsRequestBody -> Bool

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

Show PostPayoutsRequestBody

Defined in StripeAPI.Operations.PostPayouts

Methods

showsPrec :: Int -> PostPayoutsRequestBody -> ShowS

show :: PostPayoutsRequestBody -> String

showList :: [PostPayoutsRequestBody] -> ShowS

ToJSON PostPayoutsRequestBody

Defined in StripeAPI.Operations.PostPayouts

Methods

toJSON :: PostPayoutsRequestBody -> Value

toEncoding :: PostPayoutsRequestBody -> Encoding

toJSONList :: [PostPayoutsRequestBody] -> Value

toEncodingList :: [PostPayoutsRequestBody] -> Encoding

FromJSON PostPayoutsRequestBody

Defined in StripeAPI.Operations.PostPayouts

Methods

parseJSON :: Value -> Parser PostPayoutsRequestBody

parseJSONList :: Value -> Parser [PostPayoutsRequestBody]

mkPostPayoutsRequestBody

Arguments

:: Int

postPayoutsRequestBodyAmount

-> Text

postPayoutsRequestBodyCurrency

-> PostPayoutsRequestBody

Create a new PostPayoutsRequestBody with all required fields.

data PostPayoutsRequestBodyMethod'

Defines the enum schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.method in the specification.

The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)

Constructors

PostPayoutsRequestBodyMethod'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostPayoutsRequestBodyMethod'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostPayoutsRequestBodyMethod'EnumInstant

Represents the JSON value "instant"

PostPayoutsRequestBodyMethod'EnumStandard

Represents the JSON value "standard"

Instances

Eq PostPayoutsRequestBodyMethod'

Defined in StripeAPI.Operations.PostPayouts

Methods

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

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

Show PostPayoutsRequestBodyMethod'

Defined in StripeAPI.Operations.PostPayouts

Methods

showsPrec :: Int -> PostPayoutsRequestBodyMethod' -> ShowS

show :: PostPayoutsRequestBodyMethod' -> String

showList :: [PostPayoutsRequestBodyMethod'] -> ShowS

ToJSON PostPayoutsRequestBodyMethod'

Defined in StripeAPI.Operations.PostPayouts

Methods

toJSON :: PostPayoutsRequestBodyMethod' -> Value

toEncoding :: PostPayoutsRequestBodyMethod' -> Encoding

toJSONList :: [PostPayoutsRequestBodyMethod'] -> Value

toEncodingList :: [PostPayoutsRequestBodyMethod'] -> Encoding

FromJSON PostPayoutsRequestBodyMethod'

Defined in StripeAPI.Operations.PostPayouts

Methods

parseJSON :: Value -> Parser PostPayoutsRequestBodyMethod'

parseJSONList :: Value -> Parser [PostPayoutsRequestBodyMethod']

data PostPayoutsRequestBodySourceType'

Defines the enum schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_type in the specification.

The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`.

Constructors

PostPayoutsRequestBodySourceType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PostPayoutsRequestBodySourceType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PostPayoutsRequestBodySourceType'EnumBankAccount

Represents the JSON value "bank_account"

PostPayoutsRequestBodySourceType'EnumCard

Represents the JSON value "card"

PostPayoutsRequestBodySourceType'EnumFpx

Represents the JSON value "fpx"

Instances

Eq PostPayoutsRequestBodySourceType'

Defined in StripeAPI.Operations.PostPayouts

Methods

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

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

Show PostPayoutsRequestBodySourceType'

Defined in StripeAPI.Operations.PostPayouts

Methods

showsPrec :: Int -> PostPayoutsRequestBodySourceType' -> ShowS

show :: PostPayoutsRequestBodySourceType' -> String

showList :: [PostPayoutsRequestBodySourceType'] -> ShowS

ToJSON PostPayoutsRequestBodySourceType'

Defined in StripeAPI.Operations.PostPayouts

Methods

toJSON :: PostPayoutsRequestBodySourceType' -> Value

toEncoding :: PostPayoutsRequestBodySourceType' -> Encoding

toJSONList :: [PostPayoutsRequestBodySourceType'] -> Value

toEncodingList :: [PostPayoutsRequestBodySourceType'] -> Encoding

FromJSON PostPayoutsRequestBodySourceType'

Defined in StripeAPI.Operations.PostPayouts

Methods

parseJSON :: Value -> Parser PostPayoutsRequestBodySourceType'

parseJSONList :: Value -> Parser [PostPayoutsRequestBodySourceType']

data PostPayoutsResponse

Represents a response of the operation postPayouts.

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), PostPayoutsResponseError is used.

Constructors

PostPayoutsResponseError String

Means either no matching case available or a parse error

PostPayoutsResponse200 Payout

Successful response.

PostPayoutsResponseDefault Error

Error response.

Instances

Eq PostPayoutsResponse

Defined in StripeAPI.Operations.PostPayouts

Methods

(==) :: PostPayoutsResponse -> PostPayoutsResponse -> Bool

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

Show PostPayoutsResponse

Defined in StripeAPI.Operations.PostPayouts

Methods

showsPrec :: Int -> PostPayoutsResponse -> ShowS

show :: PostPayoutsResponse -> String

showList :: [PostPayoutsResponse] -> ShowS