List Virtual Accounts

Method Signature

align.virtualAccounts.list(customerId: string): Promise<VirtualAccountListResponse>

Parameters

string

required

The unique customer identifier (UUID format)

Returns

VirtualAccount[]

Array of virtual account objects

Examples

TypeScript
JavaScript

import Align from "@tolbel/align";

const align = new Align({
  apiKey: process.env.ALIGN_API_KEY!,
  environment: "sandbox",
});

const response = await align.virtualAccounts.list(
  "123e4567-e89b-12d3-a456-426614174000"
);

console.log(`Total accounts: ${response.items.length}`);

// Iterate through accounts
for (const account of response.items) {
  console.log(`${account.id}: ${account.destination_token} on ${account.destination_network}`);
}

const response = await align.virtualAccounts.list(
  "123e4567-e89b-12d3-a456-426614174000"
);

response.items.forEach((account) => {
  console.log(`${account.id}: ${account.destination_token} on ${account.destination_network}`);
});

Find Active Accounts

const response = await align.virtualAccounts.list(customerId);

const activeAccounts = response.items.filter(
  (account) => account.status === "active"
);

console.log(`Active accounts: ${activeAccounts.length}`);

Response Example

{
  "items": [
    {
      "id": "va_123",
      "status": "active",
      "source_currency": "usd",
      "source_rails": "ach",
      "destination_token": "usdc",
      "destination_network": "polygon",
      "deposit_instructions": { ... }
    },
    {
      "id": "va_456",
      "status": "active",
      "source_currency": "eur",
      "source_rails": "sepa",
      "destination_token": "eurc",
      "destination_network": "polygon",
      "deposit_instructions": { ... }
    }
  ]
}

Create Virtual Account

Create a new account

Get Virtual Account

Get specific account details

Getting Started

API Reference

List Virtual Accounts

Method Signature

Parameters

Returns

Examples

Find Active Accounts

Response Example

Create Virtual Account

Get Virtual Account

​Method Signature

​Parameters

​Returns

​Examples

​Find Active Accounts

​Response Example

​Related Methods

Create Virtual Account

Get Virtual Account

Method Signature

Parameters

Returns

Examples

Find Active Accounts

Response Example

Related Methods