The Payout object

Attributes

• id string Unique identifier for the object.
• amount integer The amount (in the smallest currency unit) that transfers to your bank account or debit card.
• arrival _ date timestamp Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
• currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
• description nullable string An arbitrary string attached to the object. Often useful for displaying to users.
• metadata nullable map 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.
• statement _ descriptor nullable string Extra information about a payout that displays on the user’s bank statement.
• status string 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.

More attributes

• object string, value is "payout"
• application _ fee nullable string Expandable Connect only
• application _ fee _ amount nullable integer Connect only
• automatic boolean
• balance _ transaction nullable string Expandable
• created timestamp
• destination nullable string Expandable
• failure _ balance _ transaction nullable string Expandable
• failure _ code nullable enum
• failure _ message nullable string
• livemode boolean
• method string
• original _ payout nullable string Expandable
• payout _ method nullable string
• reconciliation _ status enum
• reversed _ by nullable string Expandable
• source _ type string
• trace _ id nullable object
• type enum

The Payout object

{ "id": "po_1OaFDbEcg9tTZuTgNYmX0PKB", "object": "payout", "amount": 1100, "arrival_date": 1680652800, "automatic": false, "balance_transaction": "txn_1OaFDcEcg9tTZuTgYMR25tSe", "created": 1680648691, "currency": "usd", "description": null, "destination": "ba_1MtIhL2eZvKYlo2CAElKwKu2", "failure_balance_transaction": null, "failure_code": null, "failure_message": null, "livemode": false, "metadata": {}, "method": "standard", "original_payout": null, "reconciliation_status": "not_applicable", "reversed_by": null, "source_type": "card", "statement_descriptor": null, "status": "pending", "type": "bank_account"}

Create a payout

POST / v1 / payouts

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

Parameters

• amount integer Required A positive integer in cents representing how much to pay out.
• currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
• description string An arbitrary string attached to the object. Often useful for displaying to users.
• metadata map 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.
• statement _ descriptor string A string that displays on the recipient’s bank or card statement (up to 22 characters). A statement_descriptor that’s longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all. For US ACH payouts, this maps to the ACH Company Entry Description field, which the the related setting standard limits to 10 characters. Stripe truncates descriptors longer than 10 characters for US ACH payouts.

More parameters

• destination string
• method string
• payout _ method string Preview feature
• source _ type string

Returns

Returns a payout object if no initial errors are present during the payout creation (invalid routing number, insufficient funds, and so on). We initially mark the status of the payout object as pending.

Response

{ "id": "po_1OaFDbEcg9tTZuTgNYmX0PKB", "object": "payout", "amount": 1100, "arrival_date": 1680652800, "automatic": false, "balance_transaction": "txn_1OaFDcEcg9tTZuTgYMR25tSe", "created": 1680648691, "currency": "usd", "description": null, "destination": "ba_1MtIhL2eZvKYlo2CAElKwKu2", "failure_balance_transaction": null, "failure_code": null, "failure_message": null, "livemode": false, "metadata": {}, "method": "standard", "original_payout": null, "reconciliation_status": "not_applicable", "reversed_by": null, "source_type": "card", "statement_descriptor": null, "status": "pending", "type": "bank_account"}

Update a payout

POST / v1 / payouts /:id

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

Parameters

• metadata map 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.

Returns

Returns the payout object if the update succeeds. This call raises an error if update parameters are invalid.

Response

{ "id": "po_1OaFDbEcg9tTZuTgNYmX0PKB", "object": "payout", "amount": 1100, "arrival_date": 1680652800, "automatic": false, "balance_transaction": "txn_1OaFDcEcg9tTZuTgYMR25tSe", "created": 1680648691, "currency": "usd", "description": null, "destination": "ba_1MtIhL2eZvKYlo2CAElKwKu2", "failure_balance_transaction": null, "failure_code": null, "failure_message": null, "livemode": false, "metadata": { "order_id": "6735" }, "method": "standard", "original_payout": null, "reconciliation_status": "not_applicable", "reversed_by": null, "source_type": "card", "statement_descriptor": null, "status": "pending", "type": "bank_account"}