Sample - Stripe API
POST/v1/transfers/{id}/reversals

Create a transfer reversal

Creates a reversal for a specific transfer. Supply amount to reverse only part of the unreversed transfer amount, or omit it to reverse the entire remaining amount; partial reversals are allowed only for transfers to Stripe Accounts.

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

1 parameter · 5 body fields
idstringrequired
The unique identifier of the transfer to reverse.

Optional URL-encoded transfer reversal details.

amountintegeroptional
A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.
descriptionstringoptional
An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.
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`.
refund_application_feebooleanoptional
Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.

2 status codes
200Returns the created transfer reversal, including its amount, currency, transfer identifier, creation time, metadata, and related balance or refund objects when available.
amountintegerrequired
Amount, in cents (or local equivalent).
balance_transactionstringoptional
Balance transaction that describes the impact 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).
destination_payment_refundstringoptional
Linked payment refund for the transfer reversal.
idstringrequired
Unique identifier for the object.
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.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:transfer_reversal
source_refundstringoptional
ID of the refund responsible for the transfer reversal.
transferstringrequired
ID of the transfer that was reversed.
defaultError response.
errorobjectrequired

Error handling

id must identify the transfer to reverse. If provided, amount must be a positive integer in cents and cannot exceed the remaining unreversed amount; omit it to reverse the entire transfer. refund_application_fee controls whether the related application fee is refunded.