Retrieve a payout
Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
Path parameters
Query parameters
Specifies which fields in the response should be expanded.
Response
Successful response.
The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.
Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
Returns true if the payout is created by an automated payout schedule and false if it's requested manually.
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
An arbitrary string attached to the object. Often useful for displaying to users.
Error code that provides a reason for a payout failure, if available. View our list of failure codes.
Message that provides the reason for a payout failure, if available.
Unique identifier for the object.
If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
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.
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.
String representing the object's type. Objects of the same type share the same value.
ID of the v2 FinancialAccount the funds are sent to.
If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.
The source balance this payout came from, which can be one of the following: card, fpx, or bank_account.
Extra information about a payout that displays on the user's bank statement.
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.
Can be bank_account or card.