Fetch a Payment (With Expanded EMI Details)
GET/v1/payments/:id/?expand[]=emiClick to copy
Use this endpoint to retrieve the details of all the payments that you created, with the emi parameter expanded in the payments object.
Is this page helpful?
1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]2-X GET https://api.razorpay.com/v1/payments/pay_DG4ZdRK8ZnXC3k/?expand[]=emi
Success
Failure
1{2"id": "pay_DG4ZdRK8ZnXC3k",3"entity": "payment",4"amount": 200000,5"currency": "INR",6"status": "authorized",7"order_id": null,8"invoice_id": null,9"international": false,10"method": "emi",11"amount_refunded": 0,12"refund_status": null,13"captured": false,14"description": null,15"card_id": "card_DG4ZdUO3xABb20",16"bank": "ICIC",17"wallet": null,18"vpa": null,19"email": "gaurav@example.com",20"contact": "+919972000005",21"notes": [],22"fee": null,23"tax": null,24"error_code": null,25"error_description": null,26"error_source": null,27"error_step": null,28"error_reason": null,29"emi": {30"issuer": "ICIC",31"rate": 1300,32"duration": 633},34"acquirer_data": {35"auth_code": "828553"36},37"created_at": 156802607738}
Path Parameters
id *
stringUnique identifier of the payment to be retrieved.
Query Parameters
expand[]=emistring Use to expand the emi details when the payment method is emi.
Response Parameters
idstringUnique identifier of the payment.
entitystringIndicates the type of entity.
amountintegerThe payment amount in currency subunits. For example, for an amount of ₹1.00 enter 100.
currencystringThe currency in which the payment is made. Refer to the list of
that we support.statusstringThe status of the payment. Possible values:
createdauthorizedcapturedrefundedfailed
methodstringThe payment method used for making the payment. Possible values:
cardnetbankingwalletemiupi
order_idstringOrder id, if provided. Know more about
.descriptionstringDescription of the payment, if any.
internationalbooleanIndicates whether the payment is done via an international card or a domestic one.
refund_statusstringThe refund status of the payment. Possible values:
nullpartialfull
amount_refundedinteger The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to ₹1.00.
capturedbooleanIndicates if the payment is captured.
emailstringCustomer email address used for the payment.
contactstringCustomer contact number used for the payment.
feeintegerFee (including GST) charged by Razorpay.
taxintegerGST charged for the payment.
error_codestring Error that occurred during payment. For example, BAD_REQUEST_ERROR.
error_descriptionstring Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.
error_sourcestring The point of failure. For example, customer.
error_stepstring The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.
error_reasonstring The exact error reason. For example, incorrect_otp.
notesjson objectContains user-defined fields, stored for reference purposes.
created_atintegerTimestamp, in UNIX format, on which the payment was created.
card_idstringThe unique identifier of the card used by the customer to make the payment.
cardobjectDetails of the card used to make the payment.
Show child parameters (9)
upiobject Details of the UPI payment received. Only applicable if method is upi.
Show child parameters (3)
bankstring The 4-character bank code which the customer's account is associated with. For example, UTIB for Axis Bank.
vpastring The customer's VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.
walletstring The name of the wallet used by the customer to make the payment. For example, payzapp.
acquirer_dataarrayA dynamic array consisting of a unique reference numbers.
Show child parameters (3)
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
Fetch a Payment (With Expanded EMI Details)
GET/v1/payments/:id/?expand[]=emiClick to copy
Use this endpoint to retrieve the details of all the payments that you created, with the emi parameter expanded in the payments object.
Is this page helpful?
Path Parameters
id *
stringUnique identifier of the payment to be retrieved.
Query Parameters
expand[]=emistring Use to expand the emi details when the payment method is emi.
Response Parameters
idstringUnique identifier of the payment.
entitystringIndicates the type of entity.
amountintegerThe payment amount in currency subunits. For example, for an amount of ₹1.00 enter 100.
currencystringThe currency in which the payment is made. Refer to the list of
that we support.statusstringThe status of the payment. Possible values:
createdauthorizedcapturedrefundedfailed
methodstringThe payment method used for making the payment. Possible values:
cardnetbankingwalletemiupi
order_idstringOrder id, if provided. Know more about
.descriptionstringDescription of the payment, if any.
internationalbooleanIndicates whether the payment is done via an international card or a domestic one.
refund_statusstringThe refund status of the payment. Possible values:
nullpartialfull
amount_refundedinteger The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to ₹1.00.
capturedbooleanIndicates if the payment is captured.
emailstringCustomer email address used for the payment.
contactstringCustomer contact number used for the payment.
feeintegerFee (including GST) charged by Razorpay.
taxintegerGST charged for the payment.
error_codestring Error that occurred during payment. For example, BAD_REQUEST_ERROR.
error_descriptionstring Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.
error_sourcestring The point of failure. For example, customer.
error_stepstring The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.
error_reasonstring The exact error reason. For example, incorrect_otp.
notesjson objectContains user-defined fields, stored for reference purposes.
created_atintegerTimestamp, in UNIX format, on which the payment was created.
card_idstringThe unique identifier of the card used by the customer to make the payment.
cardobjectDetails of the card used to make the payment.
Show child parameters (9)
upiobject Details of the UPI payment received. Only applicable if method is upi.
Show child parameters (3)
bankstring The 4-character bank code which the customer's account is associated with. For example, UTIB for Axis Bank.
vpastring The customer's VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.
walletstring The name of the wallet used by the customer to make the payment. For example, payzapp.
acquirer_dataarrayA dynamic array consisting of a unique reference numbers.
Show child parameters (3)
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
1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]2-X GET https://api.razorpay.com/v1/payments/pay_DG4ZdRK8ZnXC3k/?expand[]=emi
Success
Failure
1{2"id": "pay_DG4ZdRK8ZnXC3k",3"entity": "payment",4"amount": 200000,5"currency": "INR",6"status": "authorized",7"order_id": null,8"invoice_id": null,9"international": false,10"method": "emi",11"amount_refunded": 0,12"refund_status": null,13"captured": false,14"description": null,15"card_id": "card_DG4ZdUO3xABb20",16"bank": "ICIC",17"wallet": null,18"vpa": null,19"email": "gaurav@example.com",20"contact": "+919972000005",21"notes": [],22"fee": null,23"tax": null,24"error_code": null,25"error_description": null,26"error_source": null,27"error_step": null,28"error_reason": null,29"emi": {30"issuer": "ICIC",31"rate": 1300,32"duration": 633},34"acquirer_data": {35"auth_code": "828553"36},37"created_at": 156802607738}