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

# account/balances

`GET /account/balances`

This endpoint returns details on your current account balances and available funds for all currencies associated with your account. Unlike /account/balance which returns a single currency, this endpoint returns an array of balances for each currency your account has records for.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `AsOfDate` string, date

## 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
  - `AccountBalances` object, required — Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items.
    - `0` object
      - `AccountBalance` string, required — Indicates the total current account balance for this currency, including pending funds.
      - `PendingFunds` string, required — Indicates the portion of the account balance which is pending due to in-progress transactions.
      - `SecurityDeposit` string, required — Indicates the portion of the account balance which is being held as a security deposit.
      - `Reserve` string, required — Indicates the portion of the account balance which is being held as a reserve against negative balances.
      - `AvailableImmediately` string, required — Indicate the portion of the account balance that is available immediately
      - `AvailableFunds` string, required — Indicates the portion of the account balance which is currently available for use. This is calculated by taking the AccountBalance and subtracting the PendingFunds, Reserve, RollingReserveNSF and RollingReserveReturns amounts.
      - `OffbookBalance` string, required — Indicates the off-book balance for this currency.
      - `Currency` string, required — 3 character currency code for the balance being returned.
      - `AsOfDate` string, date, required — The date for which the balance is being returned.
      - `VirtualAccountNumber` string, required — The virtual account number associated with this currency, if virtual accounts are enabled. Format varies: IBAN (if present), FinancialInstitutionNumber-BranchTransitNumber-AccountNumber (Canadian accounts), or ABARoutingNumber-AccountNumber (US accounts). Empty string if no virtual account exists.
      - `RollingReserveNSF` string, required — Indicates the portion of the account balance which is being held as a reserve against NSF transactions. Only present if the account has rolling reserves enabled.
      - `RollingReserveReturns` string, required — Indicates the portion of the account balance which is being held as a reserve against returned transactions. Only present if the account has rolling reserves enabled.
      - `RollupAvailableBalance` string, required — Represents the aggregated total available balance of all sub-accounts under this account for this currency. Only present if the account has sub-accounts enabled.
      - `RollupAccountBalance` string, required — Represents the aggregated total account balance of all sub-accounts under this account for this currency. Only present if the account has sub-accounts enabled.

---

[API](https://skmtc.net/vopay/apis/accounts.md) · [All operations](https://skmtc.net/vopay/apis/accounts/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vopay/accounts/revisions/7033bd231ec7/schema)