Initiate a payout reversal

This POST endpoint is used to initiate a reversal of a previously completed payout transaction.
You must specify the user_token and original payout (payout_token) in the URL path to identify which transaction should be reversed.
In the request body, you may optionally provide an amount to perform a partial reversal. If no amount is specified, the entire payout amount will be reversed.
Reversals can be performed multiple times until the full payout has been reversed.
Once the payout has been fully reversed, additional reversal attempts will be rejected. Attempting to reverse more than the remaining available amount will also result in an error.
The response will include the details of the reversal transaction, including the amount reversed, the remaining reversible balance (if any), and the status of the original payout.

Path Params
string
required

Token representing the user to pay out

string
required

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

Body Params
number
≥ 0

A positive number representing the amount to reverse from the original payout. You may reverse the full amount or a partial amount, up to the remaining unreversed balance of the payout. If omitted, the full available amount will be reversed. Partial reversals are supported. The value should be specified in the destination_currency of the original payout.

metadata
object

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

string

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

string

Optional descriptive line item that appears on the payout reversal statement, providing details about the transaction. This field is intended to help identify the purpose or source of each payout by displaying a brief summary or itemized description. Commonly includes information such as reversal reason. Note: Not all countries and banks support displaying this field.

boolean
Defaults to false

Should we notify the user via email and SMS that a payout reversal was initiated aginst their account

Headers
string

Unique key to prevent duplicate processing

Responses

400

Bad Request

401

Unauthorized

403

You do not have necessary permissions for the resource

404

Not Found

500

Internal Server Error

504

Gateway Timeout

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json