Cancel a payout

Changed on

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

post/v1/payouts/{payout}/cancel

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/payouts/{payout}/cancel
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

payoutstring required

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

amountinteger required

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

application_fee_amountinteger nullable

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

arrival_dateinteger required

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

automaticboolean required

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

createdinteger required

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

currencystring currency required

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

descriptionstring nullable

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

failure_codestring nullable

Error code that provides a reason for a payout failure, if available. View our list of failure codes.

failure_messagestring nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject nullable

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.

methodstring required

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.

object'payout' required

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

payout_methodstring nullable

ID of the v2 FinancialAccount the funds are sent to.

reconciliation_status'completed' | 'in_progress' | 'not_applicable' required

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

source_typestring required

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

statement_descriptorstring nullable

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

statusstring required

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.

type'bank_account' | 'card' required

Can be bank_account or card.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.