Fetch All Customer Identifiers

GET

/v1/virtual_accounts

Click to copy

Use this endpoint to fetch the details of all Customer Identifiers.

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 \

Success

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "va_Di5gbNptcWV8fQ",
7      "name": "Acme Corp",
8      "entity": "virtual_account",
9      "status": "closed",
10      "description": "Customer Identifier created for M/S ABC Exports",
11      "amount_expected": 2300,
12      "notes": {
13        "material": "teakwood"
14      },
15      "amount_paid": 239000,
16      "customer_id": "cust_DOMUFFiGdCaCUJ",
17      "receivers": [
18        {
19          "id": "ba_Di5gbQsGn0QSz3",
20          "entity": "bank_account",
21          "ifsc": "RATN0VAAPIS",
22          "bank_name": "RBL Bank",
23          "name": "Acme Corp",
24          "notes": [],
25          "account_number": "1112220061746877"
26        }
27      ],
28      "allowed_payers": [
29        {
30          "type": "bank_account",
31          "id":"ba_DlGmm9mSj8fjRM",
32          "bank_account": {
33            "ifsc": "UTIB0000013",
34            "account_number": "914010012345679"
35          }
36        },
37        {
38          "type": "bank_account",
39          "id":"ba_Cmtnm5tSj6agUW",
40          "bank_account": {
41            "ifsc": "UTIB0000014",
42            "account_number": "914010012345680"
43          }
44        }
45      ],
46      "close_by": 1574427237,
47      "closed_at": 1574164078,
48      "created_at": 1574143517
49    },
50    {
51      "id": "va_Dho86Avmdw6h09",
52      "name": "Acme Corp",
53      "entity": "virtual_account",
54      "status": "active",
55      "description": "Customer Identifier created for Raftar Soft",
56      "amount_expected": null,
57      "notes": {
58        "material": "oakwood"
59      },
60      "amount_paid": 0,
61      "customer_id": "cust_DOMUFFiGdCaDNK",
62      "receivers": [
63        {
64          "id": "ba_Dho86DoV16LqiO",
65          "entity": "bank_account",
66          "ifsc": "RATN0VAAPIS",
67          "bank_name": "RBL Bank",
68          "name": "Acme Corp",
69          "notes": [],
70          "account_number": "1112220046254840"
71        }
72      ],
73      "allowed_payers": [
74        {
75          "type": "bank_account",
76          "id":"ba_DlGmm9mSj8fjRM",
77          "bank_account": {
78            "ifsc": "UTIB0000013",
79            "account_number": "914010012345679"
80          }
81        },
82        {
83          "type": "bank_account",
84          "id":"ba_Cmtnm5tSj6agUW",
85          "bank_account": {
86            "ifsc": "UTIB0000014",
87            "account_number": "914010012345680"
88          }
89        }
90      ],
91      "close_by": 1574427237,
92      "closed_at": null,
93      "created_at": 1574081690
94    }
95  ]
96}

Query Parameters

from

integer

Timestamp, in seconds, from when Customer Identifiers are to be fetched.

to

integer

Timestamp, in seconds, till when Customer Identifiers are to be fetched.

count

integer

Number of Customer Identifiers 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 Customer Identifiers. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier of the Customer Identifier.

name

string

The merchant billing label as it appears on the Dashboard.

entity

string

Indicates the type of entity. Here, it is virtual account.

status

string

Indicates whether the Customer Identifier is in active or closed state.

description

string

A brief description about the Customer Identifier.

amount_expected

integer

The amount expected by the merchant.

amount_paid

integer

The amount paid by the customer into the Customer Identifier.

notes

json object

Any custom notes you might want to add to the Customer Identifier can be entered here. Check the

Notes section

to know more.

customer_id

string

Unique identifier of the customer the Customer Identifier is linked with. Check the

Customer API

section to know more.

receivers

json object

Configuration of desired receivers for the Customer Identifier.

Show child parameters (7)

allowed_payers

array

Details of customer bank accounts which will be allowed to make payments to your Customer Identifier. The parent parameter under which the customer bank account details must be passed as child parameters. You can add account details of 10 allowed payers for a Customer Identifier. For more details, refer to the

Third Party Validation

section.

Show child parameters (3)

close_by

integer

UNIX timestamp at which the Customer Identifier is scheduled to be automatically closed. The time must be at least 15 minutes after current time. The date range can be set till 2147483647 in UNIX timestamp format (equivalent to Tuesday, January 19, 2038 8:44:07 AM GMT+05:30). Any request beyond 2147483647 UNIX timestamp will fail.

closed_at

integer

UNIX timestamp at which the Customer Identifier is automatically closed.

created_at

integer

UNIX timestamp at which the Customer Identifier was created.

Fetch All Customer Identifiers

GET

/v1/virtual_accounts

Click to copy

Use this endpoint to fetch the details of all Customer Identifiers.

Is this page helpful?

Query Parameters

from

integer

Timestamp, in seconds, from when Customer Identifiers are to be fetched.

to

integer

Timestamp, in seconds, till when Customer Identifiers are to be fetched.

count

integer

Number of Customer Identifiers 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 Customer Identifiers. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier of the Customer Identifier.

name

string

The merchant billing label as it appears on the Dashboard.

entity

string

Indicates the type of entity. Here, it is virtual account.

status

string

Indicates whether the Customer Identifier is in active or closed state.

description

string

A brief description about the Customer Identifier.

amount_expected

integer

The amount expected by the merchant.

amount_paid

integer

The amount paid by the customer into the Customer Identifier.

notes

json object

Any custom notes you might want to add to the Customer Identifier can be entered here. Check the

Notes section

to know more.

customer_id

string

Unique identifier of the customer the Customer Identifier is linked with. Check the

Customer API

section to know more.

receivers

json object

Configuration of desired receivers for the Customer Identifier.

Show child parameters (7)

allowed_payers

array

Third Party Validation

section.

Show child parameters (3)

close_by

integer

closed_at

integer

UNIX timestamp at which the Customer Identifier is automatically closed.

created_at

integer

UNIX timestamp at which the Customer Identifier was created.

Curl

change language

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

Success

1{
2  "entity": "collection",
3  "count": 2,
4  "items": [
5    {
6      "id": "va_Di5gbNptcWV8fQ",
7      "name": "Acme Corp",
8      "entity": "virtual_account",
9      "status": "closed",
10      "description": "Customer Identifier created for M/S ABC Exports",
11      "amount_expected": 2300,
12      "notes": {
13        "material": "teakwood"
14      },
15      "amount_paid": 239000,
16      "customer_id": "cust_DOMUFFiGdCaCUJ",
17      "receivers": [
18        {
19          "id": "ba_Di5gbQsGn0QSz3",
20          "entity": "bank_account",
21          "ifsc": "RATN0VAAPIS",
22          "bank_name": "RBL Bank",
23          "name": "Acme Corp",
24          "notes": [],
25          "account_number": "1112220061746877"
26        }
27      ],
28      "allowed_payers": [
29        {
30          "type": "bank_account",
31          "id":"ba_DlGmm9mSj8fjRM",
32          "bank_account": {
33            "ifsc": "UTIB0000013",
34            "account_number": "914010012345679"
35          }
36        },
37        {
38          "type": "bank_account",
39          "id":"ba_Cmtnm5tSj6agUW",
40          "bank_account": {
41            "ifsc": "UTIB0000014",
42            "account_number": "914010012345680"
43          }
44        }
45      ],
46      "close_by": 1574427237,
47      "closed_at": 1574164078,
48      "created_at": 1574143517
49    },
50    {
51      "id": "va_Dho86Avmdw6h09",
52      "name": "Acme Corp",
53      "entity": "virtual_account",
54      "status": "active",
55      "description": "Customer Identifier created for Raftar Soft",
56      "amount_expected": null,
57      "notes": {
58        "material": "oakwood"
59      },
60      "amount_paid": 0,
61      "customer_id": "cust_DOMUFFiGdCaDNK",
62      "receivers": [
63        {
64          "id": "ba_Dho86DoV16LqiO",
65          "entity": "bank_account",
66          "ifsc": "RATN0VAAPIS",
67          "bank_name": "RBL Bank",
68          "name": "Acme Corp",
69          "notes": [],
70          "account_number": "1112220046254840"
71        }
72      ],
73      "allowed_payers": [
74        {
75          "type": "bank_account",
76          "id":"ba_DlGmm9mSj8fjRM",
77          "bank_account": {
78            "ifsc": "UTIB0000013",
79            "account_number": "914010012345679"
80          }
81        },
82        {
83          "type": "bank_account",
84          "id":"ba_Cmtnm5tSj6agUW",
85          "bank_account": {
86            "ifsc": "UTIB0000014",
87            "account_number": "914010012345680"
88          }
89        }
90      ],
91      "close_by": 1574427237,
92      "closed_at": null,
93      "created_at": 1574081690
94    }
95  ]
96}