Transfer Reversals
Transfer Reversals
The Transfer Reversal object represents an attempt to pull back funds from a merchant’s payout account after a transfer has been completed. It is created when a refund is initiated for a specific Transfer and records the details of that reversal event.
You can retrieve or search for Transfer Reversal objects using the following APIs:
Understanding the Transfer Reversal object
Sample TransferReversal
TransferReversal
{
"id": 335500,
"object": "transfer_reversal",
"transfer": 335500,
"amount": 11428,
"currency": "USD",
"status": "PENDING",
"paypro_data": {
"paypro_transfer_reversal_id": "trr_3RBesbK29KDiBVld0zLcELFW"
},
"date_created": "2025-04-08T16:21:52+0000",
"date_last_modified": "2025-04-15T16:57:27+0000",
"errors": []
}
The following data is available in a TransferReversal
object:
Field
Type
Sample Value
Description
id
Long
335500
Unique identifier for the transfer reversal.
object
String
"transfer_reversal"
Name of the object that this represents. Always transfer_reversal
.
transfer
Long
335500
Unique identifier for the transfer object that was reversed.
amount
Long
11428
Amount, in fractional currency unit (e.g. cents), that was reversed.
currency
String
"USD"
Currency of the transfer reversal.
status
Enum
"PENDING"
Status of the transfer: one of PENDING
, COMPLETE
, or FAILED
.
paypro_data
Map (string → value)
{ "paypro_transfer_reversal_id": "trr_3RBesbK29KDiBVld0zLcELFW" }
Additional metadata from the payment provider.
errors
List of objects
[]
Any errors that occurred during reversal. Only populated if there are issues.
date_created
String (ISO-8601)
"2025-04-08T16:21:52+0000"
Timestamp when this object was created.
date_last_modified
String (ISO-8601)
"2025-04-15T16:57:27+0000"
Timestamp of the most recent update to the object.
Webhooks
In addition to the Transfer
related events, the following events are available for you to subscribe to in order to receive notifications about Transfer Reversals:
TRANSFER_REVERSED
TRANSFER_REVERSAL_FAILED
TRANSFER_PARTIALLY_REVERSED
Learn more here
Last updated
Was this helpful?