---
title: "virtual-account"
method: GET
path: "/virtual-account"
tags: ["Virtual Account Endpoints"]
---

# virtual-account

`GET /virtual-account`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/virtual-account`
- Auth: none declared

Retrieve information about virtual accounts associated with your account. Canadian (CAD) virtual accounts are provisioned by VoPay with the bank; their FinancialInstitutionNumber and BranchTransitNumber are populated, and an account can have one virtual account per client account.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `Status` 'Active' | 'Pending' | 'Inactive'
- `Currency` string
- `ClientAccountID` string

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `VirtualAccounts` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Collection of all your virtual accounts. Empty {} when no accounts match.
    - `0` object: Virtual account records
      - `VirtualAccountID` string, required: Unique ID of the virtual account
      - `VirtualAccountNumber` string, required: The virtual account number: the IBAN when present; otherwise ABARoutingNumber-AccountNumber (US); otherwise FinancialInstitutionNumber-BranchTransitNumber-AccountNumber (Canada); empty string when none of these apply
      - `Type` string, required: Type of virtual account
      - `Status` string, required: The status of the virtual account
      - `Currency` string, required: Currency of the virtual account
      - `AccountHolderName` string, required: Name of the account holder
      - `FinancialInstitutionNumber` string, required: Financial institution number (populated for Canadian virtual accounts)
      - `BranchTransitNumber` string, required: Branch transit number (populated for Canadian virtual accounts)
      - `AccountNumber` string, required: Account number
      - `IBAN` string, required: International Bank Account Number
      - `ABARoutingNumber` string, required: ABA routing number (US)
      - `BicSwift` string, required: BIC/SWIFT code
      - `ClientAccountID` string, required: ClientAccountID the virtual account is mapped to. Empty string when the virtual account is not mapped to a client account

---

[API](https://skmtc.dev/vopay/apis/virtual-accounts.md) - [All operations](https://skmtc.dev/vopay/apis/virtual-accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/virtual-accounts/revisions/d1ddfbd67e8f?raw)