List all reversals

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

Parameters

No parameters.

More parameters

ending_beforestring

limitinteger

starting_afterstring

Returns

A dictionary with a data property that contains an array of up to limit reversals, starting after reversal starting_after. Each entry in the array is a separate reversal object. If no more reversals are available, the resulting array will be empty. If you provide a non-existent transfer ID, this call raises an error.

GET /v1/transfers/:id/reversals

curl -G https://api.stripe.com/v1/transfers/tr_1Mio2dLkdIwHu7ixsUuCxJpu/reversals \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3

Response

{
  "object": "list",
  "url": "/v1/transfers/tr_1Mio2dLkdIwHu7ixsUuCxJpu/reversals",
  "has_more": false,
  "data": [
    {
      "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"
    }
  ]
}

List all reversals

Parameters

More parametersExpand all

ending_beforestring

limitinteger

starting_afterstring

Returns

More parameters