Refunds Entity

Know about refunds entity parameters and their description.

The Refunds entity has the following parameters:

Entity

{
  "id":"rfnd_FgRAHdNOM4ZVbO",
  "entity":"refund",
  "amount":10000,
  "currency":"MYR",
  "payment_id":"pay_FgR9UMzgmKDJRi",
  "notes":{
    "notes_key_1":"Beam me up Scotty.",
    "notes_key_2":"Engage"
  },
  "receipt":null,
  "acquirer_data":{
    "arn":"10000000000000"
  },
  "created_at":1600856650,
  "batch_id":null,
  "status":"processed",
  "speed_processed":"normal",
  "speed_requested":"normal"
}

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 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.

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”.

speed · string

Speed at which the refund is to be processed. Possible value is normal, which indicates that the refund will be processed via the normal speed. The refund will take 5-7 working days.

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.

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.

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:
  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 is normal, which 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 is normal, which indicates that the refund has been processed by the payment processing partner. The refund will take 5-7 working days.