X-Razorpay-Account API request header, as shown in the Curl example.
Request
Curl
Response
Success
Parameters
id
: string Unique identifier of the payment.
entity
: string Indicates the type of entity.
amount
: string The payment amount represented in the smallest unit of the currency passed. For example, for an amount of ₹200.35, the value of this field should be 20035.
currency
: string The currency in which the payment is made. We support only INR for Route transactions.
status
: string The status of the payment. Possible values:
createdauthorizedcapturedrefundedfailed
method
: string The payment method used for making the payment. Here, it will be transfer.
order_id
: string Unique identifier of the order associated with the payment.
description
: string Description of the payment, if any.
refund_status
: string The refund status of the payment. Possible values include:
nullpartialfull
amount_refunded
: integer The amount refunded in the smallest unit of the currency passed. For example, if the amount_refunded is 100, then it translates to 100 paise, that is ₹1. Only INR is supported.
captured
: boolean Indicates whether the payment has been captured. Possible values:
true: Payment has been captured.false: Payment has not been captured.
email
: string Customer email address used for the payment.
contact
: string Customer contact number used for the payment.
fee
: integer Fee (including GST) charged by Razorpay.
tax
: integer GST charged for the payment.
error_code
: string Code for the error that occurred during payment. For example, BAD_GATEWAY_ERROR.
error_description
: string Description of the error that occurred during payment.
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.
created_at
: integer Timestamp, in Unix, on which the payment was created.
Errors
The api key/secret provided is invalid- code: 4xx
- description: 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: Make sure the API Keys are active and entered correctly. Also, there should not be any whitespaces before or after the keys.
- code: 400
- description: This error occurs when the Linked Account is invalid or does not belong to the requested merchant.
- solution: Ensure the Linked Account is valid and belongs to the requested merchant.