Reverse a Transfer

POST

/v1/transfers/:id/reversals

Click to copy

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.

Is this page helpful?

Curl

change language

1curl -X POST https://api.razorpay.com/v1/transfers/trf_EAznuJ9cDLnF7Y/reversals \
2-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
3-H 'content-type: application/json'
4-d '{
5   "amount":100,
6   "notes":{
7      "branch":"Acme Corp Bangalore North",
8      "name":"Gaurav Kumar"
9   }
10}'

Success

Failure

1{
2  "id": "rvrsl_EB0BWgGDAu7tOz",
3  "entity": "reversal",
4  "transfer_id": "trf_EAznuJ9cDLnF7Y",
5  "amount": 100,
6  "fee": 0,
7  "tax": 0,
8  "currency": "INR",
9  "notes": [],
10  "initiator_id": "CJoeHMNpi0nC7k",
11  "customer_refund_id": null,
12  "created_at": 1580456007
13}

Path Parameters

id

string

Unique identifier of the transfer to be reversed.

Request Parameters

amount

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.

notes

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

id

string

The unique identifier of the reversal.

entity

string

The name of the entity. Here, it is reversal.

transfer_id

string

The unique identifier of the transfer that was reversed.

amount

integer

The amount that was reversed, in paise.

currency

string

ISO currency code. We support route reversals only in INR.

created_at

integer

Timestamp in Unix. This indicates the time at which the reversal was created.

Errors

The api key/secret provided is invalid

Error Status: 4xx

This 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

The amount must be atleast INR 1.00

Error Status: 400

This 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

transfer_id is not a valid id

Error Status: 400

This error occurs when you pass an invalid transfer_id in the API endpoint.

Solution

Reverse a Transfer

POST

/v1/transfers/:id/reversals

Click to copy

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.

Is this page helpful?

Path Parameters

id

string

Unique identifier of the transfer to be reversed.

Request Parameters

amount

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.

notes

json object

Response Parameters

id

string

The unique identifier of the reversal.

entity

string

The name of the entity. Here, it is reversal.

transfer_id

string

The unique identifier of the transfer that was reversed.

amount

integer

The amount that was reversed, in paise.

currency

string

ISO currency code. We support route reversals only in INR.

created_at

integer

Timestamp in Unix. This indicates the time at which the reversal was created.

Errors

The api key/secret provided is invalid

Error Status: 4xx

This 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

The amount must be atleast INR 1.00

Error Status: 400

This 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

transfer_id is not a valid id

Error Status: 400

This error occurs when you pass an invalid transfer_id in the API endpoint.

Solution

Curl

change language

1curl -X POST https://api.razorpay.com/v1/transfers/trf_EAznuJ9cDLnF7Y/reversals \
2-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
3-H 'content-type: application/json'
4-d '{
5   "amount":100,
6   "notes":{
7      "branch":"Acme Corp Bangalore North",
8      "name":"Gaurav Kumar"
9   }
10}'

Success

Failure

1{
2  "id": "rvrsl_EB0BWgGDAu7tOz",
3  "entity": "reversal",
4  "transfer_id": "trf_EAznuJ9cDLnF7Y",
5  "amount": 100,
6  "fee": 0,
7  "tax": 0,
8  "currency": "INR",
9  "notes": [],
10  "initiator_id": "CJoeHMNpi0nC7k",
11  "customer_refund_id": null,
12  "created_at": 1580456007
13}