Fetch All Customer Identifiers

GET /v1/virtual_accounts

Use this endpoint to retrieve details of all Customer Identifiers.

Request

Curl

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

```java: Java
RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

JSONObject params = new JSONObject();
params.put("count","1");

List virtualaccount = instance.virtualAccounts.fetchAll(params);

```python: Python
import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.all(options)

```ruby: Ruby
require "razorpay"
Razorpay.setup('key_id', 'key_secret')

options = {"count":1}

Razorpay::VirtualAccount.all(options)

```php: PHP
$api = new Api($key_id, $secret);

$api->virtualAccount->all($options);

```javascript: Node.js
var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.all(options)

```go: Go
import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

data:= map[string]interface{}{
    "count" : 1,
}

body, err := client.VirtualAccount.All(data, nil)

```ruby: Ruby
require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

options = {"count":1}

Razorpay::VirtualAccount.all(options)

```csharp: .NET
RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]

Dictionary param = new Dictionary();
param.Add("count","1");

List virtualaccount = client.VirtualAccount.All(param);

Response

Success

{
  "entity": "collection",
  "count": 2,
  "items": [
    {
      "id": "va_Di5gbNptcWV8fQ",
      "name": "Acme Corp",
      "entity": "virtual_account",
      "status": "closed",
      "description": "Customer Identifier created for M/S ABC Exports",
      "amount_expected": 2300,
      "notes": {
        "material": "teakwood"
      },
      "amount_paid": 239000,
      "customer_id": "cust_DOMUFFiGdCaCUJ",
      "receivers": [
        {
          "id": "ba_Di5gbQsGn0QSz3",
          "entity": "bank_account",
          "ifsc": "RATN0VAAPIS",
          "bank_name": "RBL Bank",
          "name": "Acme Corp",
          "notes": [],
          "account_number": "1112220061746877"
        }
      ],
      "close_by": 1574427237,
      "closed_at": 1574164078,
      "created_at": 1574143517
    },
    {
      "id": "va_Dho86Avmdw6h09",
      "name": "Acme Corp",
      "entity": "virtual_account",
      "status": "active",
      "description": "Customer Identifier created for Raftar Soft",
      "amount_expected": null,
      "notes": {
        "material": "oakwood"
      },
      "amount_paid": 0,
      "customer_id": "cust_DOMUFFiGdCaDNK",
      "receivers": [
        {
          "id": "ba_Dho86DoV16LqiO",
          "entity": "bank_account",
          "ifsc": "RATN0VAAPIS",
          "bank_name": "RBL Bank",
          "name": "Acme Corp",
          "notes": [],
          "account_number": "1112220046254840"
        }
      ],
      "close_by": 1574427237,
      "closed_at": null,
      "created_at": 1574081690
    }
  ]
}

```json: Failure
{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

Parameters

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

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

count optional : 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 optional : integer Number of records to be skipped while fetching the Customer Identifiers. This can be used for pagination, in combination with count.

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.

id : string The unique identifier of the virtual bank account. Sample IDs for:

• Virtual bank account: ba_Di5gbQsGn0QSz3
• Virtual UPI ID: vpa_CkTmLXqVYPkbxx

entity : string Name of the entity. Possible values:

• bank_account
• vpa

ifsc : string The IFSC for the virtual bank account created. For example, RAZR0000001. This parameter appears in the response only when bank_account is passed as the receiver type.

bank_name : string The bank associated with the virtual bank account. For example, RBL Bank. This parameter appears in the response only when bank_account is passed as the receiver type.

account_number : string The unique account number provided by the bank. For example, 1112220061746877. This parameter appears in the response only when bank_account is passed as the receiver type.

name : string The merchant billing label as it appears on the Dashboard. This parameter appears in the response only when bank_account is passed as the receiver type.

notes : json object Any custom notes you might want to add to the virtual bank account can be entered here. Know more about notes. This parameter appears in the response only when bank_account is passed as the receiver type.

: json object Any custom notes you might want to add to the virtual bank account or virtual UPI ID can be entered here. Know more about notes. This parameter appears in the response only when bank_account is passed as the receiver type.

username : string The UPI ID consists of the username and the bank handle. The username consists of the namespace (assigned by the bank to Razorpay), the merchant prefix (which can be customised by you) and the descriptor (which you provide to identify the customer). The unique identifier which forms the first half of the virtual UPI ID. For example, rpy.payto00000gaurikumari. This parameter appears in the response only when vpa is passed as the receiver type. The descriptor can be 10 characters only.

handle : string The bank name that forms the second half of the virtual UPI ID. For example, icici. This parameter appears in the response only when vpa is passed as the receiver type.

address : string The UPI ID that combines the username and the handle with the @ symbol. For example, rpy.payto00000gaurikumari@icici. This parameter appears in the response only when vpa is passed as the receiver type.

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 “ provided is invalid.

• code: 4xx
• description: Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.
• solution: Make sure that the API keys are active and entered correctly. Also, make sure there are no whitespaces before or after the keys.