Sample - Stripe API
POST/v1/payouts/{payout}

Update a payout

Updates the metadata associated with a payout without changing parameters that you omit. Use metadata to attach or remove key-value pairs and expand to request expanded response fields.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
payoutstringrequired
The unique identifier of the payout to update; it may contain up to 5000 characters.

Optional form-encoded payout update parameters; only metadata and response expansion are supported.

expandarray<string>optional
Specifies which fields in the response should be expanded.
metadataobjectoptional
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`.

2 status codes
200Returns the updated payout object with the submitted metadata applied.
amountintegerrequired
The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
application_feestringoptional
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_amountintegeroptional
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.
arrival_dateintegerrequired
Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
automaticbooleanrequired
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_transactionstringoptional
ID of the balance transaction that describes the impact of this payout on your account balance.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
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).
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
destinationstringoptional
ID of the bank account or card the payout is sent to.
failure_balance_transactionstringoptional
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_codestringoptional
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).
failure_messagestringoptional
Message that provides the reason for a payout failure, if available.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectoptional
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.
methodstringrequired
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).
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:payout
original_payoutstringoptional
If the payout reverses another, this is the ID of the original payout.
payout_methodstringoptional
ID of the v2 FinancialAccount the funds are sent to.
reconciliation_statusstringrequired
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.
Allowed:completedin_progressnot_applicable
reversed_bystringoptional
If the payout reverses, this is the ID of the payout that reverses this payout.
source_typestringrequired
The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.
statement_descriptorstringoptional
Extra information about a payout that displays on the user's bank statement.
statusstringrequired
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`.
trace_idobjectoptional
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.
typestringrequired
Can be `bank_account` or `card`.
Allowed:bank_accountcard
defaultReturned when the request cannot be processed; the response contains an error object with a `type` field.
errorobjectrequired

Error handling

payout must identify an existing payout and may contain up to 5000 characters. metadata must be a set of string key-value pairs or an empty string to remove metadata, and only metadata-related values can be changed.