Razorpay Docs (original) (raw)

Fetch Payments for a QR Code

GET

/v1/payments/qr_codes/:id/payments

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

1

curl -u : \

2

-X GET https://api.razorpay.com/v1/payments/qr_codes/qr_FuZIYx6rMbP6gs/payments \

2

"entity": "collection",

6

  "id": "pay_HMtDKn3TnF4D8x",

13

  "international": false,

16

  "refund_status": null,

18

  "description": "QRv2 Payment",

22

  "vpa": "gauri.kumari@okhdfcbank",

23

  "email": "gauri.kumari@example.com",

24

  "contact": "+919000090000",

25

  "customer_id": "cust_HKsR5se84c5LTO",

30

  "error_description": null,

37

  "created_at": 1623662800

40

  "id": "pay_HMsr242ZnaLumA",

47

  "international": false,

49

  "amount_refunded": 1000,

50

  "refund_status": "full",

52

  "description": "QRv2 Payment",

56

  "vpa": "gauri.kumari@okhdfcbank",

57

  "email": "gauri.kumari@example.com",

58

  "contact": "+919000090000",

59

  "customer_id": "cust_HKsR5se84c5LTO",

64

  "error_description": null,

71

  "created_at": 1623661533

Path Parameters

The unique identifier of the QR Code.

Query Parameters

Unix timestamp, in seconds, from when payments are to be retrieved.

Unix timestamp, in seconds, till when payments are to be fetched.

Number of payments to be fetched.

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

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

Response Parameters

Unique identifier of the payment.

Indicates the type of entity.

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

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

that we support.

The status of the payment. Possible values:

• created
• authorized
• captured
• refunded
• failed

The payment method used for making the payment. Possible values:

• card
• netbanking
• wallet
• upi

Order id, if provided. Know more about

.

Description of the payment, if any.

Indicates whether the payment is done via an international card or a domestic one. Possible values:

• true: Payment made using international card.
• false: Payment not made using international card.

The refund status of the payment. Possible values:

• null
• partial
• full

The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to ₹1.00.

Indicates if the payment is captured. Possible values:

• true: Payment has been captured.
• false: Payment has not been captured.

Customer email address used for the payment.

Customer contact number used for the payment.

Fee (including GST) charged by Razorpay.

GST charged for the payment.

Error that occurred during payment. For example, BAD_REQUEST_ERROR.

Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.

The point of failure. For example, customer.

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.

The exact error reason. For example, incorrect_otp.

Contains user-defined fields, stored for reference purposes.

Timestamp, in UNIX format, on which the payment was created.

The unique identifier of the card used by the customer to make the payment.

Details of the card used to make the payment.

Show child parameters (9)

Details of the UPI payment received. Only applicable if method is upi.

Show child parameters (3)

The 4-character bank code which the customer's account is associated with. For example, UTIB for Axis Bank.

The customer's VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.

The name of the wallet used by the customer to make the payment. For example, payzapp.

A dynamic array consisting of a unique reference numbers.

Show child parameters (3)

Errors

The API {key/secret} provided is invalid.

The API credentials passed in the API call differ from the ones generated on the Dashboard.

{Qr code id} is not a valid id.

A wrong QR Code id is provided.

The requested URL was not found on the server.

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

No QR Code is found for the search criteria.

Fetch Payments for a QR Code

GET

/v1/payments/qr_codes/:id/payments

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

Path Parameters

The unique identifier of the QR Code.

Query Parameters

Unix timestamp, in seconds, from when payments are to be retrieved.

Unix timestamp, in seconds, till when payments are to be fetched.

Number of payments to be fetched.

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

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

Response Parameters

Unique identifier of the payment.

Indicates the type of entity.

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

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

that we support.

The status of the payment. Possible values:

• created
• authorized
• captured
• refunded
• failed

The payment method used for making the payment. Possible values:

• card
• netbanking
• wallet
• upi

Order id, if provided. Know more about

.

Description of the payment, if any.

Indicates whether the payment is done via an international card or a domestic one. Possible values:

• true: Payment made using international card.
• false: Payment not made using international card.

The refund status of the payment. Possible values:

• null
• partial
• full

The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to ₹1.00.

Indicates if the payment is captured. Possible values:

• true: Payment has been captured.
• false: Payment has not been captured.

Customer email address used for the payment.

Customer contact number used for the payment.

Fee (including GST) charged by Razorpay.

GST charged for the payment.

Error that occurred during payment. For example, BAD_REQUEST_ERROR.

Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.

The point of failure. For example, customer.

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.

The exact error reason. For example, incorrect_otp.

Contains user-defined fields, stored for reference purposes.

Timestamp, in UNIX format, on which the payment was created.

The unique identifier of the card used by the customer to make the payment.

Details of the card used to make the payment.

Show child parameters (9)

Details of the UPI payment received. Only applicable if method is upi.

Show child parameters (3)

The 4-character bank code which the customer's account is associated with. For example, UTIB for Axis Bank.

The customer's VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.

The name of the wallet used by the customer to make the payment. For example, payzapp.

A dynamic array consisting of a unique reference numbers.

Show child parameters (3)

Errors

The API {key/secret} provided is invalid.

The API credentials passed in the API call differ from the ones generated on the Dashboard.

{Qr code id} is not a valid id.

A wrong QR Code id is provided.

The requested URL was not found on the server.

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

No QR Code is found for the search criteria.

1

curl -u : \

2

-X GET https://api.razorpay.com/v1/payments/qr_codes/qr_FuZIYx6rMbP6gs/payments \

2

"entity": "collection",

6

  "id": "pay_HMtDKn3TnF4D8x",

13

  "international": false,

16

  "refund_status": null,

18

  "description": "QRv2 Payment",

22

  "vpa": "gauri.kumari@okhdfcbank",

23

  "email": "gauri.kumari@example.com",

24

  "contact": "+919000090000",

25

  "customer_id": "cust_HKsR5se84c5LTO",

30

  "error_description": null,

37

  "created_at": 1623662800

40

  "id": "pay_HMsr242ZnaLumA",

47

  "international": false,

49

  "amount_refunded": 1000,

50

  "refund_status": "full",

52

  "description": "QRv2 Payment",

56

  "vpa": "gauri.kumari@okhdfcbank",

57

  "email": "gauri.kumari@example.com",

58

  "contact": "+919000090000",

59

  "customer_id": "cust_HKsR5se84c5LTO",

64

  "error_description": null,

71

  "created_at": 1623661533