API Test Keys

Create an Instant Refund

POST

/v1/payments/:id/refund

Click to copy

Use this endpoint to process refunds instantaneously to your customers. The instant refund is enabled by default for your account. You should set the refund speed to optimum when creating a refund request to ensure refunds are processed instantly. We will consider the default speed if you do not specify the same during the refund request. Know more about

setting the default speed

from the Razorpay dashboard.

Refunds will be processed at an optimal speed based on Razorpay's internal fund transfer logic.
If the refund can be processed instantly, Razorpay will do so irrespective of the payment method used to make the payment.
If an Instant Refund is not possible, Razorpay will initiate a refund that is processed at the normal speed.

Know more about

Instant Refunds

Once the refund moves to the processed state, the refund response displays the speed_processed parameter, the final state of the refund.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X POST https://api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f/refund \
3-H 'Content-Type: application/json' \
4-d '{
5  "amount":500100,
6  "speed":"optimum",
7  "receipt":"Receipt No. 31",
8  "notes":{
9    "notes_key_1":"Tea, Earl Grey, Hot",
10    "notes_key_2":"Tea, Earl Grey… decaf."
11  }
12}'

Success

Failure

1{
2  "id": "rfnd_FP8R8EGjGbPkVb",
3  "entity": "refund",
4  "amount": 500100,
5  "currency": "INR",
6  "payment_id": "pay_29QQoUBi66xm2f",
7  "notes": {
8    "notes_key_1": "Tea, Earl Grey, Hot",
9    "notes_key_2": "Tea, Earl Grey… decaf."
10  },
11  "receipt": "Receipt No. 31",
12  "acquirer_data": {
13    "arn": null
14  },
15  "created_at": 1597078914,
16  "batch_id": null,
17  "status": "processed",
18  "speed_processed": "normal",
19  "speed_requested": "optimum"
20}

Path Parameters

id

string

The unique identifier of the payment which needs to be refunded.

Request Parameters

amount

integer

The amount to be refunded. Amount should be in the smallest unit of the currency in which the payment was made. Required in case of partial refund.

For a partial refund, enter a value lesser than the payment amount. For example, if the payment amount is ₹1200 and you want to refund only ₹200, you must pass 20000.
For full refund, enter the entire payment amount. If amount parameter is not passed, the entire payment amount will be refunded.

speed

string

Here, it must be optimum. Indicates that the refund will be processed at an optimal speed based on Razorpay's internal fund transfer logic.

If the refund can be processed instantly, Razorpay will do so, irrespective of the payment method used to make the payment.
If an instant refund is not possible, Razorpay will initiate a refund that is processed at the normal speed.

notes

json object

This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

receipt

string

A unique identifier provided by you for your internal reference.

Response Parameters

id

string

The unique identifier of the refund. For example, rfnd_FgRAHdNOM4ZVbO.

entity

string

Indicates the type of entity. Here, it is refund.

amount

integer

The amount to be refunded (in the smallest unit of currency).
For example, if the refund value is MYR 30.00 it will be 3000.

currency

string

The currency of payment amount for which the refund is initiated.

payment_id

string

The unique identifier of the payment for which a refund is initiated. For example, pay_FgR9UMzgmKDJRi.

created_at

integer

Unix timestamp at which the refund was created. For example, 1600856650.

batch_id

string

This parameter is populated if the refund was created as part of a batch upload. For example, batch_00000000000001

notes

json object

Key-value store for storing your reference data. A maximum of 15 key-value pairs can be included. For example, "note_key": "Beam me up Scotty”.

receipt

string

A unique identifier provided by you for your internal reference.

acquirer_data

array

A dynamic array consisting of a unique reference number (either RRN, ARN or UTR) that is provided by the banking partner when a refund is processed. This reference number can be used by the customer to track the status of the refund with the bank.

status

string

Indicates the state of the refund. Possible values:

pending: This state indicates that Curlec is attempting to process the refund.
processed: This is the final state of the refund.
failed: A refund can attain the failed state in the following scenarios:
Refund is not possible for a payment which is more than 6 months old.

speed_requested

string

The processing mode of the refund seen in the refund response.
This attribute is seen in the refund response only if the speed parameter is set in the refund request.
Possible value:

normal: Indicates that the refund will be processed via the normal speed. The refund will take 5-7 working days.

speed_processed

string

This is a parameter in the response which describes the mode used to process a refund.
This attribute is seen in the refund response only if the speed parameter is set in the refund request. Possible value:

normal: Indicates that the refund has been processed by the payment processing partner. The refund will take 5-7 working days.

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution

{Payment_id} is not a valid id.

Error Status: 400

The payment_id provided is invalid.

Solution

The requested URL was not found on the server.

Error Status: 400

Possible reasons:

The URL is wrong or is missing something.
A POST API is executed by GET method.

Solution

{any Extra field} is/are not required and should not be sent.

Error Status: 400

An additional or unrequired parameter is passed.

Solution

The refund amount provided is greater than amount captured.

Error Status: 400

The refund amount entered is more than the amount captured.

Solution

The amount must be atleast INR 1.00.

Error Status: 400

The refund amount entered is less than ₹1.

Solution

The payment has been fully refunded already.

Error Status: 400

The payment_id has already been refunded fully.

Solution

Create an Instant Refund

POST

/v1/payments/:id/refund

Click to copy

setting the default speed

from the Razorpay dashboard.

Refunds will be processed at an optimal speed based on Razorpay's internal fund transfer logic.
If the refund can be processed instantly, Razorpay will do so irrespective of the payment method used to make the payment.
If an Instant Refund is not possible, Razorpay will initiate a refund that is processed at the normal speed.

Know more about

Instant Refunds

Once the refund moves to the processed state, the refund response displays the speed_processed parameter, the final state of the refund.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the payment which needs to be refunded.

Request Parameters

amount

integer

The amount to be refunded. Amount should be in the smallest unit of the currency in which the payment was made. Required in case of partial refund.

For a partial refund, enter a value lesser than the payment amount. For example, if the payment amount is ₹1200 and you want to refund only ₹200, you must pass 20000.
For full refund, enter the entire payment amount. If amount parameter is not passed, the entire payment amount will be refunded.

speed

string

Here, it must be optimum. Indicates that the refund will be processed at an optimal speed based on Razorpay's internal fund transfer logic.

If the refund can be processed instantly, Razorpay will do so, irrespective of the payment method used to make the payment.
If an instant refund is not possible, Razorpay will initiate a refund that is processed at the normal speed.

notes

json object

receipt

string

A unique identifier provided by you for your internal reference.

Response Parameters

id

string

The unique identifier of the refund. For example, rfnd_FgRAHdNOM4ZVbO.

entity

string

Indicates the type of entity. Here, it is refund.

amount

integer

The amount to be refunded (in the smallest unit of currency).
For example, if the refund value is MYR 30.00 it will be 3000.

currency

string

The currency of payment amount for which the refund is initiated.

payment_id

string

The unique identifier of the payment for which a refund is initiated. For example, pay_FgR9UMzgmKDJRi.

created_at

integer

Unix timestamp at which the refund was created. For example, 1600856650.

batch_id

string

This parameter is populated if the refund was created as part of a batch upload. For example, batch_00000000000001

notes

json object

Key-value store for storing your reference data. A maximum of 15 key-value pairs can be included. For example, "note_key": "Beam me up Scotty”.

receipt

string

A unique identifier provided by you for your internal reference.

acquirer_data

array

status

string

Indicates the state of the refund. Possible values:

pending: This state indicates that Curlec is attempting to process the refund.
processed: This is the final state of the refund.
failed: A refund can attain the failed state in the following scenarios:
Refund is not possible for a payment which is more than 6 months old.

speed_requested

string

The processing mode of the refund seen in the refund response.
This attribute is seen in the refund response only if the speed parameter is set in the refund request.
Possible value:

normal: Indicates that the refund will be processed via the normal speed. The refund will take 5-7 working days.

speed_processed

string

normal: Indicates that the refund has been processed by the payment processing partner. The refund will take 5-7 working days.

Errors

The API {key/secret} provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard.

Solution

{Payment_id} is not a valid id.

Error Status: 400

The payment_id provided is invalid.

Solution

The requested URL was not found on the server.

Error Status: 400

Possible reasons:

The URL is wrong or is missing something.
A POST API is executed by GET method.

Solution

{any Extra field} is/are not required and should not be sent.

Error Status: 400

An additional or unrequired parameter is passed.

Solution

The refund amount provided is greater than amount captured.

Error Status: 400

The refund amount entered is more than the amount captured.

Solution

The amount must be atleast INR 1.00.

Error Status: 400

The refund amount entered is less than ₹1.

Solution

The payment has been fully refunded already.

Error Status: 400

The payment_id has already been refunded fully.

Solution

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X POST https://api.razorpay.com/v1/payments/pay_29QQoUBi66xm2f/refund \
3-H 'Content-Type: application/json' \
4-d '{
5  "amount":500100,
6  "speed":"optimum",
7  "receipt":"Receipt No. 31",
8  "notes":{
9    "notes_key_1":"Tea, Earl Grey, Hot",
10    "notes_key_2":"Tea, Earl Grey… decaf."
11  }
12}'

Success

Failure

1{
2  "id": "rfnd_FP8R8EGjGbPkVb",
3  "entity": "refund",
4  "amount": 500100,
5  "currency": "INR",
6  "payment_id": "pay_29QQoUBi66xm2f",
7  "notes": {
8    "notes_key_1": "Tea, Earl Grey, Hot",
9    "notes_key_2": "Tea, Earl Grey… decaf."
10  },
11  "receipt": "Receipt No. 31",
12  "acquirer_data": {
13    "arn": null
14  },
15  "created_at": 1597078914,
16  "batch_id": null,
17  "status": "processed",
18  "speed_processed": "normal",
19  "speed_requested": "optimum"
20}