API Test Keys

Fetch Payments of a Linked Account

GET

/v1/payments/

Click to copy

Use this endpoint to fetch a list of all the payments received by a Linked Account. For this, you should send the Linked Account id in the X-Razorpay-Account API request header, as shown in the Curl example.

Is this page helpful?

Curl

change language

1curl -X GET https://api.razorpay.com/v1/payments \
2-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
3-H 'X-Razorpay-Account: acc_IRQWUleX4BqvYn' \

Success

Failure

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "pay_JJCqynf4fQS0N1",
7      "entity": "payment",
8      "amount": 10000,
9      "currency": "INR",
10      "status": "captured",
11      "order_id": "order_JJCqnZG8f3754z",
12      "invoice_id": null,
13      "international": false,
14      "method": "netbanking",
15      "amount_refunded": 0,
16      "refund_status": null,
17      "captured": true,
18      "description": "#JJCqaOhFihfkVE",
19      "card_id": null,
20      "bank": "YESB",
21      "wallet": null,
22      "vpa": null,
23      "email": "john.example@example.com",
24      "contact": "+919820958250",
25      "notes": [],
26      "fee": 236,
27      "tax": 36,
28      "error_code": null,
29      "error_description": null,
30      "error_source": null,
31      "error_step": null,
32      "error_reason": null,
33      "acquirer_data": {
34        "bank_transaction_id": "2118867"
35      },
36      "created_at": 1649932775
37    },
38    {
39      "id": "pay_JHAe1Zat55GbZB",
40      "entity": "payment",
41      "amount": 5000,
42      "currency": "INR",
43      "status": "captured",
44      "order_id": "order_IluGWxBm9U8zJ8",
45      "invoice_id": null,
46      "international": false,
47      "method": "netbanking",
48      "amount_refunded": 0,
49      "refund_status": null,
50      "captured": true,
51      "description": "Test Transaction",
52      "card_id": null,
53      "bank": "KKBK",
54      "wallet": null,
55      "vpa": null,
56      "email": "gaurav.kumar@example.com",
57      "contact": "+919000090000",
58      "notes": {
59        "address": "Razorpay Corporate Office"
60      },
61      "fee": 118,
62      "tax": 18,
63      "error_code": null,
64      "error_description": null,
65      "error_source": null,
66      "error_step": null,
67      "error_reason": null,
68      "acquirer_data": {
69        "bank_transaction_id": "7003347"
70      },
71      "created_at": 1649488316
72    }
73  ]
74}

Response Parameters

id

string

Unique identifier of the payment.

entity

string

Indicates the type of entity.

amount

string

The payment amount represented in the smallest unit of the currency passed. For example, for an amount of ₹200.35, the value of this field should be 20035.

currency

string

The currency in which the payment is made. We support only INR for Route transactions.

status

string

The status of the payment. Possible values:

created
authorized
captured
refunded
failed

method

string

The payment method used for making the payment. Here, it will be transfer.

order_id

string

Unique identifier of the order associated with the payment.

description

string

Description of the payment, if any.

refund_status

string

The refund status of the payment. Possible values include:

null
partial
full

amount_refunded

integer

The amount refunded in the smallest unit of the currency passed. For example, if the amount_refunded is 100, then it translates to 100 paise, that is ₹1. Only INR is supported.

captured

boolean

Indicates whether the payment has been 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

Code for the error that occurred during payment. For example, BAD_GATEWAY_ERROR.

error_description

string

Description of the error that occurred during payment.

notes

json object

Set of key-value pairs that can be associated with an entity. These pairs can be useful for storing additional information about the entity. A maximum of 15 key-value pairs, each of 256 characters (maximum), are supported.

created_at

integer

Timestamp, in Unix, on which the payment was created.

Errors

The api key/secret provided is invalid

Error Status: 4xx

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

Solution

The id provided does not exist

Error Status: 400

This error occurs when the Linked Account is invalid or does not belong to the requested merchant.

Solution

Fetch Payments of a Linked Account

GET

/v1/payments/

Click to copy

Is this page helpful?

Response Parameters

id

string

Unique identifier of the payment.

entity

string

Indicates the type of entity.

amount

string

The payment amount represented in the smallest unit of the currency passed. For example, for an amount of ₹200.35, the value of this field should be 20035.

currency

string

The currency in which the payment is made. We support only INR for Route transactions.

status

string

The status of the payment. Possible values:

created
authorized
captured
refunded
failed

method

string

The payment method used for making the payment. Here, it will be transfer.

order_id

string

Unique identifier of the order associated with the payment.

description

string

Description of the payment, if any.

refund_status

string

The refund status of the payment. Possible values include:

null
partial
full

amount_refunded

integer

The amount refunded in the smallest unit of the currency passed. For example, if the amount_refunded is 100, then it translates to 100 paise, that is ₹1. Only INR is supported.

captured

boolean

Indicates whether the payment has been 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

Code for the error that occurred during payment. For example, BAD_GATEWAY_ERROR.

error_description

string

Description of the error that occurred during payment.

notes

json object

created_at

integer

Timestamp, in Unix, on which the payment was created.

Errors

The api key/secret provided is invalid

Error Status: 4xx

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

Solution

The id provided does not exist

Error Status: 400

This error occurs when the Linked Account is invalid or does not belong to the requested merchant.

Solution

Curl

change language

1curl -X GET https://api.razorpay.com/v1/payments \
2-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
3-H 'X-Razorpay-Account: acc_IRQWUleX4BqvYn' \

Success

Failure

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "pay_JJCqynf4fQS0N1",
7      "entity": "payment",
8      "amount": 10000,
9      "currency": "INR",
10      "status": "captured",
11      "order_id": "order_JJCqnZG8f3754z",
12      "invoice_id": null,
13      "international": false,
14      "method": "netbanking",
15      "amount_refunded": 0,
16      "refund_status": null,
17      "captured": true,
18      "description": "#JJCqaOhFihfkVE",
19      "card_id": null,
20      "bank": "YESB",
21      "wallet": null,
22      "vpa": null,
23      "email": "john.example@example.com",
24      "contact": "+919820958250",
25      "notes": [],
26      "fee": 236,
27      "tax": 36,
28      "error_code": null,
29      "error_description": null,
30      "error_source": null,
31      "error_step": null,
32      "error_reason": null,
33      "acquirer_data": {
34        "bank_transaction_id": "2118867"
35      },
36      "created_at": 1649932775
37    },
38    {
39      "id": "pay_JHAe1Zat55GbZB",
40      "entity": "payment",
41      "amount": 5000,
42      "currency": "INR",
43      "status": "captured",
44      "order_id": "order_IluGWxBm9U8zJ8",
45      "invoice_id": null,
46      "international": false,
47      "method": "netbanking",
48      "amount_refunded": 0,
49      "refund_status": null,
50      "captured": true,
51      "description": "Test Transaction",
52      "card_id": null,
53      "bank": "KKBK",
54      "wallet": null,
55      "vpa": null,
56      "email": "gaurav.kumar@example.com",
57      "contact": "+919000090000",
58      "notes": {
59        "address": "Razorpay Corporate Office"
60      },
61      "fee": 118,
62      "tax": 18,
63      "error_code": null,
64      "error_description": null,
65      "error_source": null,
66      "error_step": null,
67      "error_reason": null,
68      "acquirer_data": {
69        "bank_transaction_id": "7003347"
70      },
71      "created_at": 1649488316
72    }
73  ]
74}