Payments Entity
The Payments entity has the following parameters:
Is this page helpful?
Success
Failure
1{2"id": "pay_L0nSsccovt6zyp",3"entity": "payment",4"amount": 9900,5"currency": "INR",6"status": "captured",7"order_id": "order_L0nS83FfCHaWqV",8"invoice_id": "inv_L0nS7JIyuX6Lyb",9"international": false,10"method": "card",11"amount_refunded": 0,12"refund_status": null,13"captured": true,14"description": "#L0nS7JIyuX6Lyb",15"card_id": "card_L0nSsfPv1LjA20",16"card": {17"id": "card_L0nSsfPv1LjA20",18"entity": "card",19"name": "",20"last4": "1111",21"network": "Visa",22"type": "debit",23"issuer": null,24"international": false,25"emi": false,26"sub_type": "consumer",27"token_iin": null28},29"bank": null,30"wallet": null,31"vpa": null,32"email": "gaurav.kumar@example.com",33"contact": "+9000090000",34"notes": [],35"fee": 198,36"tax": 0,37"error_code": null,38"error_description": null,39"error_source": null,40"error_step": null,41"error_reason": null,42"acquirer_data": {43"auth_code": "299196"44},45"created_at": 167298741746}
id
string
Unique identifier of the payment.
entity
string
Indicates the type of entity.
amount
*
integer
Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is ₹299.00, then pass 29900
in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to accept 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 charge 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 in which the payment is made. Refer to the list of
that we support.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).status
string
The status of the payment. Possible values:
created
authorized
captured
refunded
failed
method
string
The payment method used for making the payment. Possible values:
card
netbanking
wallet
emi
upi
order_id
string
Order id, if provided. Know more about
.description
string
Description of the payment, if any.
international
boolean
Indicates whether the payment is done via an international card or a domestic one.
refund_status
string
The refund status of the payment. Possible values:
null
partial
full
amount_refunded
integer
The amount refunded in currency subunits. For example, if amount_refunded = 100
, it is equal to ₹1.00.
captured
boolean
Indicates if the payment is 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
Error that occurred during payment. For example, BAD_REQUEST_ERROR
.
error_description
string
Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP
.
error_source
string
The point of failure. For example, customer
.
error_step
string
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_reason
string
The exact error reason. For example, incorrect_otp
.
notes
json object
Contains user-defined fields, stored for reference purposes.
created_at
integer
Timestamp, in UNIX format, on which the payment was created.
card_id
string
The unique identifier of the card used by the customer to make the payment.
card
object
Details of the card used to make the payment.
Show child parameters (9)
upi
object
Details of the UPI payment received. Only applicable if method
is upi
.
Show child parameters (3)
bank
string
The 4-character bank code which the customer's account is associated with. For example, UTIB
for Axis Bank.
vpa
string
The customer's VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi
.
wallet
string
The name of the wallet used by the customer to make the payment. For example, payzapp
.
acquirer_data
array
A dynamic array consisting of a unique reference numbers.
Show child parameters (3)
Payments Entity
The Payments entity has the following parameters:
Is this page helpful?
id
string
Unique identifier of the payment.
entity
string
Indicates the type of entity.
amount
*
integer
Payment amount in the smallest currency sub-unit. For example, if the amount to be charged is ₹299.00, then pass 29900
in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to accept a payment of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, to accept 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 charge 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 in which the payment is made. Refer to the list of
that we support.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).status
string
The status of the payment. Possible values:
created
authorized
captured
refunded
failed
method
string
The payment method used for making the payment. Possible values:
card
netbanking
wallet
emi
upi
order_id
string
Order id, if provided. Know more about
.description
string
Description of the payment, if any.
international
boolean
Indicates whether the payment is done via an international card or a domestic one.
refund_status
string
The refund status of the payment. Possible values:
null
partial
full
amount_refunded
integer
The amount refunded in currency subunits. For example, if amount_refunded = 100
, it is equal to ₹1.00.
captured
boolean
Indicates if the payment is 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
Error that occurred during payment. For example, BAD_REQUEST_ERROR
.
error_description
string
Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP
.
error_source
string
The point of failure. For example, customer
.
error_step
string
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_reason
string
The exact error reason. For example, incorrect_otp
.
notes
json object
Contains user-defined fields, stored for reference purposes.
created_at
integer
Timestamp, in UNIX format, on which the payment was created.
card_id
string
The unique identifier of the card used by the customer to make the payment.
card
object
Details of the card used to make the payment.
Show child parameters (9)
upi
object
Details of the UPI payment received. Only applicable if method
is upi
.
Show child parameters (3)
bank
string
The 4-character bank code which the customer's account is associated with. For example, UTIB
for Axis Bank.
vpa
string
The customer's VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi
.
wallet
string
The name of the wallet used by the customer to make the payment. For example, payzapp
.
acquirer_data
array
A dynamic array consisting of a unique reference numbers.
Show child parameters (3)
Success
Failure
1{2"id": "pay_L0nSsccovt6zyp",3"entity": "payment",4"amount": 9900,5"currency": "INR",6"status": "captured",7"order_id": "order_L0nS83FfCHaWqV",8"invoice_id": "inv_L0nS7JIyuX6Lyb",9"international": false,10"method": "card",11"amount_refunded": 0,12"refund_status": null,13"captured": true,14"description": "#L0nS7JIyuX6Lyb",15"card_id": "card_L0nSsfPv1LjA20",16"card": {17"id": "card_L0nSsfPv1LjA20",18"entity": "card",19"name": "",20"last4": "1111",21"network": "Visa",22"type": "debit",23"issuer": null,24"international": false,25"emi": false,26"sub_type": "consumer",27"token_iin": null28},29"bank": null,30"wallet": null,31"vpa": null,32"email": "gaurav.kumar@example.com",33"contact": "+9000090000",34"notes": [],35"fee": 198,36"tax": 0,37"error_code": null,38"error_description": null,39"error_source": null,40"error_step": null,41"error_reason": null,42"acquirer_data": {43"auth_code": "299196"44},45"created_at": 167298741746}