Skip to main content
POST
Available in🇮🇳 India🇸🇬 Singapore🇺🇸 United States
Use this endpoint to create reversals on a particular transfer_id.
  • The amount specified is debited from the Linked Account balance and credited to your balance.
  • Partial reversals are also supported, and you can create multiple reversals on a transfer_id. If you do not provide the amount parameter in the request, then the entire amount of the transfer is reversed.
Handy Tips If a reversal ID is generated, the reversal was successful.

Path Parameters

string
required
Unique identifier of the transfer to be reversed.

Request Parameters

integer
The amount to be reversed from the Linked Account to your account. If this parameter is not passed, the entire transfer amount will be reversed.
json object
Set of key-value pairs that can be associated with an entity. These pairs can be useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported. For example, "region": "south", "city": "Bangalore".

Response Parameters

string
The unique identifier of the reversal.
string
The name of the entity. Here, it is reversal.
string
The unique identifier of the transfer that was reversed.
integer
The amount that was reversed, in paise.
string
ISO currency code. We support route reversals only in INR.
integer
Timestamp in Unix. This indicates the time at which the reversal was created.

Errors

Code: 4xxThis error occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the Dashboard.Solution: Make sure the API Keys are active and entered correctly. Also, there should not be any whitespaces before or after the keys.
Code: 400This error occurs when the amount is less than the minimum amount. The transaction amount expressed in the currency subunit, such as paise (in INR) should always be greater than or equal to ₹1.Solution: Make sure the amount is equal to or greater than the minimum amount of ₹1.
Code: 400This error occurs when you pass an invalid transfer_id in the API endpoint.Solution: Make sure to pass a vaild transfer_id.
Code: 400Insufficient balance in the linked account to complete the reversal.Solution: Ensure that you have sufficient balance in your linked account to complete the reversal.