API Test Keys

Fetch Payments for a QR Code

GET
/v1/payments/qr_codes/:qr_id/payments

Click to copy

Use this endpoint to fetch the payments made on a QR Code using this endpoint.

Is this page helpful?

Curl

1
curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2
-X GET https://api.razorpay.com/v1/payments/qr_codes/qr_FuZIYx6rMbP6gs/payments \

Success

1
{
2
"entity": "collection",
3
"count": 2,
4
"items": [
5
{
6
"id": "pay_HMtDKn3TnF4D8x",
7
"entity": "payment",
8
"amount": 500,
9
"currency": "INR",
10
"status": "captured",
11
"order_id": null,
12
"invoice_id": null,
13
"international": false,
14
"method": "upi",
15
"amount_refunded": 0,
16
"refund_status": null,
17
"captured": true,
18
"description": "QRv2 Payment",
19
"card_id": null,
20
"bank": null,
21
"wallet": null,
22
"vpa": "gauri.kumari@okhdfcbank",
23
"email": "gauri.kumari@example.com",
24
"contact": "+919000090000",
25
"customer_id": "cust_HKsR5se84c5LTO",
26
"notes": [],
27
"fee": 0,
28
"tax": 0,
29
"error_code": null,
30
"error_description": null,
31
"error_source": null,
32
"error_step": null,
33
"error_reason": null,
34
"acquirer_data": {
35
"rrn": "116514257019"
36
},
37
"created_at": 1623662800
38
},
39
{
40
"id": "pay_HMsr242ZnaLumA",
41
"entity": "payment",
42
"amount": 1000,
43
"currency": "INR",
44
"status": "refunded",
45
"order_id": null,
46
"invoice_id": null,
47
"international": false,
48
"method": "upi",
49
"amount_refunded": 1000,
50
"refund_status": "full",
51
"captured": true,
52
"description": "QRv2 Payment",
53
"card_id": null,
54
"bank": null,
55
"wallet": null,
56
"vpa": "gauri.kumari@okhdfcbank",
57
"email": "gauri.kumari@example.com",
58
"contact": "+919000090000",
59
"customer_id": "cust_HKsR5se84c5LTO",
60
"notes": [],
61
"fee": 0,
62
"tax": 0,
63
"error_code": null,
64
"error_description": null,
65
"error_source": null,
66
"error_step": null,
67
"error_reason": null,
68
"acquirer_data": {
69
"rrn": "116514090501"
70
},
71
"created_at": 1623661533
72
}
73
]
74
}
Path Parameters
id

*

string

The unique identifier of the QR Code.

Query Parameters
from
integer

Timestamp, in seconds, from when payments are to be fetched.

to
integer

Timestamp, in seconds, till when payments are to be fetched.

count
integer

Number of payments to be fetched.

  • Default value: 10
  • Maximum value: 100
  • This can be used for pagination, in combination with skip.

skip
integer

Number of records to be skipped while fetching the payments. This can be used for pagination, in combination with count.

Response Parameters
id
string

Unique identifier of the payment.

entity
string

Indicates the type of entity.

amount
integer

The payment amount in currency subunits. For example, for an amount of ₹1.00 enter 100.

currency
string

The currency in which the payment is made. Refer to the list of

that we support.

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)

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

{Qr code id} is not a valid id.

Error Status: 400

A wrong QR Code id is provided.

Solution

The requested URL was not found on the server.

Error Status: 400

  • The URL is wrong or is missing something.
  • A GET API is executed by POST Method.

Solution

"count": 0

Error Status: 400

No QR Code is found for the search criteria.

Solution

Fetch Payments for a QR Code

GET
/v1/payments/qr_codes/:qr_id/payments

Click to copy

Use this endpoint to fetch the payments made on a QR Code using this endpoint.

Is this page helpful?

Path Parameters
id

*

string

The unique identifier of the QR Code.

Query Parameters
from
integer

Timestamp, in seconds, from when payments are to be fetched.

to
integer

Timestamp, in seconds, till when payments are to be fetched.

count
integer

Number of payments to be fetched.

  • Default value: 10
  • Maximum value: 100
  • This can be used for pagination, in combination with skip.

skip
integer

Number of records to be skipped while fetching the payments. This can be used for pagination, in combination with count.

Response Parameters
id
string

Unique identifier of the payment.

entity
string

Indicates the type of entity.

amount
integer

The payment amount in currency subunits. For example, for an amount of ₹1.00 enter 100.

currency
string

The currency in which the payment is made. Refer to the list of

that we support.

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)

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

{Qr code id} is not a valid id.

Error Status: 400

A wrong QR Code id is provided.

Solution

The requested URL was not found on the server.

Error Status: 400

  • The URL is wrong or is missing something.
  • A GET API is executed by POST Method.

Solution

"count": 0

Error Status: 400

No QR Code is found for the search criteria.

Solution

Curl

1
curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2
-X GET https://api.razorpay.com/v1/payments/qr_codes/qr_FuZIYx6rMbP6gs/payments \

Success

1
{
2
"entity": "collection",
3
"count": 2,
4
"items": [
5
{
6
"id": "pay_HMtDKn3TnF4D8x",
7
"entity": "payment",
8
"amount": 500,
9
"currency": "INR",
10
"status": "captured",
11
"order_id": null,
12
"invoice_id": null,
13
"international": false,
14
"method": "upi",
15
"amount_refunded": 0,
16
"refund_status": null,
17
"captured": true,
18
"description": "QRv2 Payment",
19
"card_id": null,
20
"bank": null,
21
"wallet": null,
22
"vpa": "gauri.kumari@okhdfcbank",
23
"email": "gauri.kumari@example.com",
24
"contact": "+919000090000",
25
"customer_id": "cust_HKsR5se84c5LTO",
26
"notes": [],
27
"fee": 0,
28
"tax": 0,
29
"error_code": null,
30
"error_description": null,
31
"error_source": null,
32
"error_step": null,
33
"error_reason": null,
34
"acquirer_data": {
35
"rrn": "116514257019"
36
},
37
"created_at": 1623662800
38
},
39
{
40
"id": "pay_HMsr242ZnaLumA",
41
"entity": "payment",
42
"amount": 1000,
43
"currency": "INR",
44
"status": "refunded",
45
"order_id": null,
46
"invoice_id": null,
47
"international": false,
48
"method": "upi",
49
"amount_refunded": 1000,
50
"refund_status": "full",
51
"captured": true,
52
"description": "QRv2 Payment",
53
"card_id": null,
54
"bank": null,
55
"wallet": null,
56
"vpa": "gauri.kumari@okhdfcbank",
57
"email": "gauri.kumari@example.com",
58
"contact": "+919000090000",
59
"customer_id": "cust_HKsR5se84c5LTO",
60
"notes": [],
61
"fee": 0,
62
"tax": 0,
63
"error_code": null,
64
"error_description": null,
65
"error_source": null,
66
"error_step": null,
67
"error_reason": null,
68
"acquirer_data": {
69
"rrn": "116514090501"
70
},
71
"created_at": 1623661533
72
}
73
]
74
}