v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB

Payout Reversal

Get status of a payout reversal

This GET endpoint is used to retrieve the status of a payout reversal transaction for a user with the specified token and payout reversal token. <br> You can use this endpoint to check whether a reversal has been successfully processed, partially applied, or if it encountered an error. <br> To use this endpoint, you need to provide the user_token, original payout_token and payout_reversal_token in the URL Path. <br> The response will include a JSON object containing details about the reversal transaction, including its status and any remaining reversible amount.

get/payout/{user_token}/{payout_token}/reversal/{payout_reversal_token}

Path parameters

user_tokenstring required

Token representing the user to pay out

payout_tokenstring required

Token representing the trsanaction. Retrieved from /payout/{user_token}

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

successful operation

payout_reversal_tokenstring required

Payout Reversal Token

source_amountnumber required

The amount that was reversed in this transaction. This can be a full or partial reversal of the original payout, depending on the requested reversal amount. The value is expressed in the same currency as the original payout.

source_currency_codestring required

Currency code for the amount that will be loaded onto the source_token

exchange_ratenumber required

Exchange rate between the source and destination amounts

destination_amountnumber required

The amount that will be debited from the attr_set_token

destination_currency_codestring required

The currency in which the funds were received and will be debited from the attr_set_token associated with the original payout_token

Status of Payout Reversal

payout_tokenstring required

Token of the Payout the reversal is applied to

metadataobject required

Optional JSON object with attributes that are attached to the payout reversal transaction

feenumber required

Fee associated with the payout reversal

client_transfer_idstring

A client defined transfer identifier. This is the unique ID assigned to the transfer on your system. Max 50 characters.

original_destination_amountnumber required

The original destination amount that was deposited in the payout

total_reversed_amountnumber required

The total amount that was reversed against the original payout so far

createdstring date-time required

Datetime of when the reversal was created. Provided in UTC

completedstring date-time

Datetime of when the payout reversal was completed and credited to the source_token of the original payout. Provided in UTC

Example response

{
  "original_destination_amount": 1000.34,
  "total_reversed_amount": 10.2
}