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

# virtual-account/balance

`GET /virtual-account/balance`

## Request

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

Retrieve the balance for a specific virtual account.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `VirtualAccountID` 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
  - `VirtualAccountBalances` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Balances of the virtual accounts. Empty {} when no virtual accounts match.
    - `0` object
      - `VirtualAccountID` string, required: Unique ID of the virtual account
      - `Currency` string, required: Currency code
      - `AccountBalance` string, required: Current balance of the virtual account
      - `PendingBalance` string, required: Pending balance of the virtual account
      - `AvailableBalance` string, required: AccountBalance minus PendingBalance
      - `ClientAccountID` string, required: ClientAccountID the virtual account is mapped to. Empty string when 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)