Create a transfer reversal

Changed on

When you create a new reversal, you must specify a transfer to create it on.

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

post/v1/transfers/{id}/reversals

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/transfers/{id}/reversals
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

idstring required

Request body application/x-www-form-urlencoded

amountinteger

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.

descriptionstring

An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.

expandstring[]

Specifies which fields in the response should be expanded.

refund_application_feeboolean

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.

Response

Successful response.

amountinteger required

Amount, in cents (or local equivalent).

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.

idstring required

Unique identifier for the object.

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.

object'transfer_reversal' required

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

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.