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.
Parameters
- amountinteger
A positive integer in cents 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.
- metadataobject
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
More parameters
- 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.
Returns
Returns a transfer reversal object if the reversal succeeded. Raises an error if the transfer has already been reversed or an invalid transfer identifier was provided.
{ "id": "trr_1Mio2eLkdIwHu7ixN5LPJS4a", "object": "transfer_reversal", "amount": 400, "balance_transaction": "txn_1Mio2eLkdIwHu7ixosfrbjhW", "created": 1678147568, "currency": "usd", "destination_payment_refund": "pyr_1Mio2eQ9PRzxEwkZYewpaIFB", "metadata": {}, "source_refund": null, "transfer": "tr_1Mio2dLkdIwHu7ixsUuCxJpu"}