API Test Keys

Fetch All Customer Identifiers

GET

/v1/virtual_accounts

Click to copy

Use this endpoint to retrieve 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

Failure

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      "close_by": 1574427237,
29      "closed_at": 1574164078,
30      "created_at": 1574143517
31    },
32    {
33      "id": "va_Dho86Avmdw6h09",
34      "name": "Acme Corp",
35      "entity": "virtual_account",
36      "status": "active",
37      "description": "Customer Identifier created for Raftar Soft",
38      "amount_expected": null,
39      "notes": {
40        "material": "oakwood"
41      },
42      "amount_paid": 0,
43      "customer_id": "cust_DOMUFFiGdCaDNK",
44      "receivers": [
45        {
46          "id": "ba_Dho86DoV16LqiO",
47          "entity": "bank_account",
48          "ifsc": "RATN0VAAPIS",
49          "bank_name": "RBL Bank",
50          "name": "Acme Corp",
51          "notes": [],
52          "account_number": "1112220046254840"
53        }
54      ],
55      "close_by": 1574427237,
56      "closed_at": null,
57      "created_at": 1574081690
58    }
59  ]
60}

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. Know more about

notes

customer_id

string

Unique identifier of the customer the Customer Identifier is linked with. Know more about

Customer API

receivers

json object

Configuration of desired receivers for the Customer Identifier.

Show child parameters (10)

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).

Watch Out!

Any request beyond 2147483647 UNIX timestamp will fail.
A Customer Identifier API that has not been used for 90 days will be automatically closed even if no close_by date has been set.

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.

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 All Customer Identifiers

GET

/v1/virtual_accounts

Click to copy

Use this endpoint to retrieve 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. Know more about

notes

customer_id

string

Unique identifier of the customer the Customer Identifier is linked with. Know more about

Customer API

receivers

json object

Configuration of desired receivers for the Customer Identifier.

Show child parameters (10)

close_by

integer

Watch Out!

Any request beyond 2147483647 UNIX timestamp will fail.
A Customer Identifier API that has not been used for 90 days will be automatically closed even if no close_by date has been set.

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.

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 \

Success

Failure

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      "close_by": 1574427237,
29      "closed_at": 1574164078,
30      "created_at": 1574143517
31    },
32    {
33      "id": "va_Dho86Avmdw6h09",
34      "name": "Acme Corp",
35      "entity": "virtual_account",
36      "status": "active",
37      "description": "Customer Identifier created for Raftar Soft",
38      "amount_expected": null,
39      "notes": {
40        "material": "oakwood"
41      },
42      "amount_paid": 0,
43      "customer_id": "cust_DOMUFFiGdCaDNK",
44      "receivers": [
45        {
46          "id": "ba_Dho86DoV16LqiO",
47          "entity": "bank_account",
48          "ifsc": "RATN0VAAPIS",
49          "bank_name": "RBL Bank",
50          "name": "Acme Corp",
51          "notes": [],
52          "account_number": "1112220046254840"
53        }
54      ],
55      "close_by": 1574427237,
56      "closed_at": null,
57      "created_at": 1574081690
58    }
59  ]
60}