API Test Keys

Refunds Entity

The Refunds entity has the following parameters:

Is this page helpful?

Entity

1
{
2
"id":"rfnd_FgRAHdNOM4ZVbO",
3
"entity":"refund",
4
"amount":10000,
5
"currency":"INR",
6
"payment_id":"pay_FgR9UMzgmKDJRi",
7
"notes":{
8
"notes_key_1":"Beam me up Scotty.",
9
"notes_key_2":"Engage"
10
},
11
"receipt":null,
12
"acquirer_data":{
13
"arn":"10000000000000"
14
},
15
"created_at":1600856650,
16
"batch_id":null,
17
"status":"processed",
18
"speed_processed":"normal",
19
"speed_requested":"normal"
20
}
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 ₹30.00 it will be 3000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

currency
string

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

.

Handy Tips

Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about

(May 2024).

payment_id
string

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

speed
string

Speed at which the refund is to be processed. Possible values:

  • normal: Indicates that the refund will be processed via the normal speed. The refund will take 5-7 working days.
  • 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. For example, in case of payments made using debit cards, netbanking or unsupported credit cards.

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 Razorpay 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:
    • Normal refund is not possible for a payment which is more than 6 months old.
    • Instant Refund can sometimes fail because of customer's account or bank-related issues.

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 values:

  • normal: Indicates that the refund will be processed via the normal speed. The refund will take 5-7 working days.
  • 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.

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 values:

  • instant: Indicates that the refund has been processed instantly via fund transfer.
  • normal: Indicates that the refund has been processed by the payment processing partner. The refund will take 5-7 working days.

Refunds Entity

The Refunds entity has the following parameters:

Is this page helpful?

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 ₹30.00 it will be 3000. In the case of three decimal currencies, such as KWD, BHD and OMR, to refund a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to refund a payment of 295, pass the value as 295.

Watch Out!

As per payment guidelines, you should pass the last decimal number as 0 for three decimal currency payments. For example, if you want to refund a customer 99.991 KD for a transaction, you should pass the value for the amount parameter as 99990 and not 99991.

currency
string

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

.

Handy Tips

Razorpay has added support for zero decimal currencies, such as JPY, and three decimal currencies, such as KWD, BHD, and OMR, allowing businesses to accept international payments in these currencies. Know more about

(May 2024).

payment_id
string

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

speed
string

Speed at which the refund is to be processed. Possible values:

  • normal: Indicates that the refund will be processed via the normal speed. The refund will take 5-7 working days.
  • 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. For example, in case of payments made using debit cards, netbanking or unsupported credit cards.

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 Razorpay 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:
    • Normal refund is not possible for a payment which is more than 6 months old.
    • Instant Refund can sometimes fail because of customer's account or bank-related issues.

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 values:

  • normal: Indicates that the refund will be processed via the normal speed. The refund will take 5-7 working days.
  • 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.

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 values:

  • instant: Indicates that the refund has been processed instantly via fund transfer.
  • normal: Indicates that the refund has been processed by the payment processing partner. The refund will take 5-7 working days.

Entity

1
{
2
"id":"rfnd_FgRAHdNOM4ZVbO",
3
"entity":"refund",
4
"amount":10000,
5
"currency":"INR",
6
"payment_id":"pay_FgR9UMzgmKDJRi",
7
"notes":{
8
"notes_key_1":"Beam me up Scotty.",
9
"notes_key_2":"Engage"
10
},
11
"receipt":null,
12
"acquirer_data":{
13
"arn":"10000000000000"
14
},
15
"created_at":1600856650,
16
"batch_id":null,
17
"status":"processed",
18
"speed_processed":"normal",
19
"speed_requested":"normal"
20
}