notes parameter for a refund. You can modify an existing refund to update the notes field only.
- Notes can be used to record additional information about the payment.
- You can add up to 15 key-value pairs with each value of the key not exceeding 256 characters.
Request
Curl
Response
Success
Parameters
id mandatory
: string Unique identifier of the refund for which the notes field should be updated.
Parameters
notes mandatory
: json object Additional information to be modified or added as part of notes field in key-pair format. Know more about notes.
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 30, it will be 3000.
currency
: string The currency of payment amount for which the refund is initiated. Check the list of supported currencies.
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 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.
Errors
The API {key/secret} provided is invalid.- code: 4xx
- description: The API credentials passed in the API call differ from the ones generated on the Dashboard.
- solution: The API keys must be active and entered correctly with no whitespace before or after.
- code: 400
- description: Possible reasons: - A PATCH API is executed by POST method.
- The URL is wrong or is missing something.
- The refund id is not entered.
- solution: - Use the correct method, that is, PATCH.
- Ensure that the URL is correct and complete.
- Use a valid refund id.
- code: 400
- description: The refund id entered is invalid or incomplete.
- solution: Use a valid and complete refund id.
- code: 400
- description: The request body does not include the
notesparameter. - solution: Ensure you enter the
notesparameter in the request body.