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

Update a transfer reversal

Updates an existing transfer reversal without changing values that you omit. Use the request body to manage metadata or request expanded response fields for the reversal.

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

2 parameters · 2 body fields
idstringrequired
The unique identifier of the reversal to update.
transferstringrequired
The unique identifier of the transfer containing the reversal.

Optional URL-encoded fields for updating a transfer reversal.

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 transfer reversal, including its amount, currency, transfer identifier, metadata, and related 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

transfer must identify the parent transfer and id must identify the reversal to update. metadata must contain string key-value pairs or an empty value when unsetting metadata.