Stripe: Payouts schemas

4 Stripe schemas with complete fields and constraints.

Cancel a payout — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, and list all payouts. Payouts are made on [varying schedules](/docs/connect/manage-payout-schedule), depending on your country and industry. Related guide: [Receiving payouts](https://docs.stripe.com/payouts)
`amount`	JSON	Required within parent
`amount (anyOf 1)`	integer	Alternative	The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
`amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`application_fee`	JSON	Optional
`application_fee (anyOf 1)`	JSON	Alternative	The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.
`application_fee (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`application_fee (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Post Application Fees Id Refund — response body
`application_fee (anyOf 2)`	null	Alternative
`application_fee_amount`	JSON	Optional
`application_fee_amount (anyOf 1)`	JSON	Alternative
`application_fee_amount (anyOf 1) (anyOf 1)`	integer	Alternative	The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.
`application_fee_amount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`application_fee_amount (anyOf 2)`	null	Alternative
`arrival_date`	JSON	Required within parent
`arrival_date (anyOf 1)`	integer	Alternative	Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. Format: unix-time
`arrival_date (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`automatic`	boolean	Required within parent	Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).
`balance_transaction`	JSON	Optional
`balance_transaction (anyOf 1)`	JSON	Alternative	ID of the balance transaction that describes the impact of this payout on your account balance.
`balance_transaction (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`balance_transaction (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body
`balance_transaction (anyOf 2)`	null	Alternative
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`currency`	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`description (anyOf 2)`	null	Alternative
`destination`	JSON	Optional
`destination (anyOf 1)`	JSON	Alternative	ID of the bank account or card the payout is sent to.
`destination (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`destination (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Retrieve a bank account — response body
`destination (anyOf 1) (anyOf 3)`	Model	Alternative	Expand Retrieve a card — customers get Customers Customer Cards Id — response body
`destination (anyOf 1) (anyOf 4)`	Model	Alternative	Expand Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: bank account
`destination (anyOf 1) (anyOf 5)`	Model	Alternative	Expand Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: card
`destination (anyOf 2)`	null	Alternative
`failure_balance_transaction`	JSON	Optional
`failure_balance_transaction (anyOf 1)`	JSON	Alternative	If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.
`failure_balance_transaction (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`failure_balance_transaction (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Retrieve a balance transaction — balance get Balance History Id — response body
`failure_balance_transaction (anyOf 2)`	null	Alternative
`failure_code`	JSON	Optional
`failure_code (anyOf 1)`	string	Alternative	Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures). Maximum length: 5000
`failure_code (anyOf 2)`	null	Alternative
`failure_message`	JSON	Optional
`failure_message (anyOf 1)`	string	Alternative	Message that provides the reason for a payout failure, if available. Maximum length: 5000
`failure_message (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`metadata`	JSON	Optional
`metadata (anyOf 1)`	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
`metadata (anyOf 1).*`	string	Additional keys	Maximum length: 500
`metadata (anyOf 2)`	null	Alternative
`method`	string	Required within parent	The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). Maximum length: 5000
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: payout
`original_payout`	JSON	Optional
`original_payout (anyOf 1)`	JSON	Alternative	If the payout reverses another, this is the ID of the original payout.
`original_payout (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`original_payout (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Cancel a payout — response body
`original_payout (anyOf 2)`	null	Alternative
`payout_method`	JSON	Optional
`payout_method (anyOf 1)`	string	Alternative	ID of the v2 FinancialAccount the funds are sent to. Maximum length: 5000
`payout_method (anyOf 2)`	null	Alternative
`reconciliation_status`	string	Required within parent	If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. Known values: completed, in_progress, not_applicable
`reversed_by`	JSON	Optional
`reversed_by (anyOf 1)`	JSON	Alternative	If the payout reverses, this is the ID of the payout that reverses this payout.
`reversed_by (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`reversed_by (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Cancel a payout — response body
`reversed_by (anyOf 2)`	null	Alternative
`source_type`	string	Required within parent	The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. Maximum length: 5000
`statement_descriptor`	JSON	Optional
`statement_descriptor (anyOf 1)`	string	Alternative	Extra information about a payout that displays on the user's bank statement. Maximum length: 5000
`statement_descriptor (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. Maximum length: 5000
`trace_id`	JSON	Optional
`trace_id (anyOf 1)`	JSON	Alternative	A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.
`trace_id (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a payout — response body — trace id value status, value
`trace_id (anyOf 2)`	null	Alternative
`type`	string	Required within parent	Can be `bank_account` or `card`. Known values: bank_account, card

Referenced models: Post Application Fees Id Refund — response body, Retrieve a balance transaction — balance get Balance History Id — response body, Retrieve a bank account — response body, Retrieve a card — customers get Customers Customer Cards Id — response body, Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: bank account, Delete an external account — accounts.deleteAccountsAccountBankAccountsId — response body — deleted: True, object: card, Cancel a payout — response body, Cancel a payout — response body — trace id value status, value

Cancel a payout — response body — trace id value status, value

Field	Type	Presence	Description and constraints
`$`	object	Root
`status`	string	Required within parent	Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`. Maximum length: 5000
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. Maximum length: 5000
`value (anyOf 2)`	null	Alternative

Reverse a payout — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`expand`	array	Optional	Specifies which fields in the response should be expanded.
`expand[]`	string	Each item	Maximum length: 5000
`metadata`	object	Optional	Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`. Additional keys: see wildcard field
`metadata.*`	string	Additional keys

Update a payout — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`expand`	array	Optional	Specifies which fields in the response should be expanded.
`expand[]`	string	Each item	Maximum length: 5000
`metadata`	JSON	Optional	Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
`metadata (anyOf 1)`	object	Alternative	Additional keys: see wildcard field
`metadata (anyOf 1).*`	string	Additional keys
`metadata (anyOf 2)`	string	Alternative	One of:

Report an issue with this page