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

# account/balance

`GET /account/balance`

This endpoint returns details on your current account balance and available funds.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `Currency` string
- `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
  - `AccountBalance` number, required — Indicates the total current account balance, including pending funds.
  - `PendingFunds` number, required — Indicates the portion of the account balance which is pending due to in-progress transactions.
  - `Reserve` number, required — Indicates the portion of the account balance which is being held as a reserve against negative balances.
  - `RollingReserveNSF` number — Indicates the portion of the account balance which is being held as a reserve against NSF transactions.
  - `RollingReserveReturns` number — Indicates the portion of the account balance which is being held as a reserve against returned transactions.
  - `AvailableImmediately` number, required — Indicate the portion of the account balance that is available immediately
  - `AvailableFunds` number, 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.
  - `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.
  - `RollupAvailableBalance` string — Represents the aggregated total available balance of all sub-accounts under this account. This is only returned if the account has sub-accounts enabled.
  - `RollupAccountBalance` string — Represents the aggregated total account balance of all sub-accounts under this account. This is only returned 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)