API Test Keys

Fetch Payments for a Customer Identifier

GET

/v1/virtual_accounts/:id/payments

Click to copy

Use this endpoint to retrieve payment details for a single Customer Identifier by id.

Is this page helpful?

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET \
3https://api.razorpay.com/v1/virtual_accounts/va_CminDKtoToBGmd/payments \

Success

Failure

1{
2  "entity": "collection",
3  "count": 1,
4  "items": [
5    {
6      "id": "pay_JGmL38CqCHTyZZ",
7      "entity": "payment",
8      "amount": 1000,
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": null,
19      "card_id": null,
20      "bank": null,
21      "wallet": null,
22      "vpa": "gaurav.kumar@exampleupi",
23      "email": "gaurav.kumar@example.com",
24      "contact": "+919000090000",
25      "customer_id": "cust_HWj3MjySAHSjtq",
26      "notes": [],
27      "fee": 12,
28      "tax": 2,
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": "209817848101"
36      },
37      "created_at": 1649402719
38    }
39  ]
40}

Path Parameters

id

string

The unique identifier of the Customer Identifier for which the payment details are to be fetched.

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. The default value is 10 and the maximum value is 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 S$1.00 enter 100.

currency

string

The currency in which the payment is made.

status

string

The status of the payment. Possible values:

created
authorized
captured
refunded
failed

order_id

string

Order id, if provided. Know more about

Orders

description

string

Description of the payment, if any.

international

boolean

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.

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 S$1.00.

captured

boolean

Indicates if the payment is 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.

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.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

Solution

Fetch Payments for a Customer Identifier

GET

/v1/virtual_accounts/:id/payments

Click to copy

Use this endpoint to retrieve payment details for a single Customer Identifier by id.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the Customer Identifier for which the payment details are to be fetched.

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. The default value is 10 and the maximum value is 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 S$1.00 enter 100.

currency

string

The currency in which the payment is made.

status

string

The status of the payment. Possible values:

created
authorized
captured
refunded
failed

order_id

string

Order id, if provided. Know more about

Orders

description

string

Description of the payment, if any.

international

boolean

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.

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 S$1.00.

captured

boolean

Indicates if the payment is 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.

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.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

Solution

Curl

change language

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET \
3https://api.razorpay.com/v1/virtual_accounts/va_CminDKtoToBGmd/payments \

Success

Failure

1{
2  "entity": "collection",
3  "count": 1,
4  "items": [
5    {
6      "id": "pay_JGmL38CqCHTyZZ",
7      "entity": "payment",
8      "amount": 1000,
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": null,
19      "card_id": null,
20      "bank": null,
21      "wallet": null,
22      "vpa": "gaurav.kumar@exampleupi",
23      "email": "gaurav.kumar@example.com",
24      "contact": "+919000090000",
25      "customer_id": "cust_HWj3MjySAHSjtq",
26      "notes": [],
27      "fee": 12,
28      "tax": 2,
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": "209817848101"
36      },
37      "created_at": 1649402719
38    }
39  ]
40}