Get Virtual Account

Method Signature

align.virtualAccounts.get(
  customerId: string,
  virtualAccountId: string
): Promise<VirtualAccount>

Parameters

string

required

The unique customer identifier

string

required

The unique virtual account identifier

Returns

string

Unique identifier for the virtual account

string

Account status: active

string

Wallet address where funds will be sent

object

Bank account details. Properties vary by account type.

Show Properties

object

For USD accounts: {(account_number, routing_number)}

object

For EUR accounts: {(iban_number, bic)}

string

Bank Name

Type-Safe Instruction Access: Since deposit_instructions is a discriminated union, we recommend using the SDK’s built-in type guards to safely narrow the type: - isUSAccountDetails(instr): For USD (ACH/Wire) accounts. - isIBANAccountDetails(instr): For EUR (SEPA) accounts. - isInternationalWireAccountDetails(instr): For USD (SWIFT) accounts.

Examples

import { isUSAccountDetails, isIBANAccountDetails } from "@tolbel/align";

const account = await align.virtualAccounts.get(customerId, "va_123");

// Use type-safe helper functions for narrowing
if (isUSAccountDetails(account.deposit_instructions)) {
  console.log(`US Account: ${account.deposit_instructions.us.account_number}`);
} else if (isIBANAccountDetails(account.deposit_instructions)) {
  console.log(`IBAN: ${account.deposit_instructions.iban.iban_number}`);
}

Create Virtual Account

Create a new virtual account

List Virtual Accounts

List all accounts

Getting Started

API Reference

Get Virtual Account

Method Signature

Parameters

Returns

Examples

Create Virtual Account

List Virtual Accounts

​Method Signature

​Parameters

​Returns

​Examples

​Related Methods

Create Virtual Account

List Virtual Accounts

Method Signature

Parameters

Returns

Examples

Related Methods