The Payout object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  The amount (in cents) that transfers to your bank account or debit card.

• arrival_datetimestamp

  Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.

• currencyenum

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

• descriptionnullable string

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

• metadatanullable object

  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_descriptornullable string

  Extra information about a payout that displays on the user’s bank statement.

• statusstring

  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

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• application_feenullable stringExpandableConnect only

  The application fee (if any) for the payout. See the Connect documentation for details.

• application_fee_amountnullable integerConnect only

  The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.

• automaticboolean

  Returns true if the payout is created by an automated payout schedule and false if it’s requested manually.

• balance_transactionnullable stringExpandable

  ID of the balance transaction that describes the impact of this payout on your account balance.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• destinationnullable stringExpandable

  ID of the bank account or card the payout is sent to.

• failure_balance_transactionnullable stringExpandable

  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_codenullable enum

  Error code that provides a reason for a payout failure, if available.

  Possible enum values

  account_closed The bank account has been closed.

  account_frozen The bank account has been frozen.

  bank_account_restricted The bank account has restrictions on either the type, or the number, of payouts allowed. This normally indicates that the bank account is a savings or other non-checking account.

  bank_ownership_changed The destination bank account is no longer valid because its branch has changed ownership.

  could_not_process The bank could not process this payout.

  debit_not_authorized Debit transactions are not approved on the bank account. (Stripe requires bank accounts to be set up for both credit and debit payouts.)

  declined The bank has declined this transfer. Please contact the bank before retrying.

  incorrect_account_holder_address Your bank notified us that the bank account holder address on file is incorrect.

  incorrect_account_holder_name Your bank notified us that the bank account holder name on file is incorrect.

  incorrect_account_holder_tax_id Your bank notified us that the bank account holder tax ID on file is incorrect.

  Show 7 more

• failure_messagenullable string

  Message that provides the reason for a payout failure, if available.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• methodstring

  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.

• original_payoutnullable stringExpandable

  If the payout reverses another, this is the ID of the original payout.

• payout_methodnullable string

  ID of the v2 FinancialAccount the funds are sent to.

• reconciliation_statusenum

  If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.

  Possible enum values

  completed The Balance Transactions paid out in this payout. You can query it with the Balance Transactions API.

  in_progress You can query the Balance Transactions paid out in this payout soon.

  not_applicable We don’t support listing Balance Transactions for this payout. We only support this for standard automatic payouts.

• reversed_bynullable stringExpandable

  If the payout reverses, this is the ID of the payout that reverses this payout.

• source_typestring

  The source balance this payout came from, which can be one of the following: card, fpx, or bank_account.

• trace_idnullable object

  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.

  Hide child attributes

  • trace_id.statusstring

    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.

  • trace_id.valuenullable string

    The trace ID value if trace_id.status is supported, otherwise nil.

• typeenum

  Can be bank_account or card.