---
title: "account/client-accounts/balance"
method: GET
path: "/account/client-accounts/balance"
tags: ["Client Account Management Endpoints"]
---

# account/client-accounts/balance

`GET /account/client-accounts/balance`

This endpoint returns details on the current account balance and available funds for the given Client account.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientAccountID` string, required
- `Currency` string

## Response `200`

- object
  - `Success` boolean — True if the request was successful, false if it failed
  - `ErrorMessage` string — Contains a description of the error if the request failed
  - `AccountBalance` number — Indicates the total current account balance, including pending funds.
  - `PendingFunds` number — Indicates the portion of the account balance which is pending due to in-progress transactions.
  - `Reserve` number — Indicates the portion of the account balance which is being held as a reserve against returned or fraudulent transactions.
  - `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.
  - `AvailableFunds` number — Indicates the portion of the account balance which is currently available for use. This is calculated by taking the AccountBalance and subtracting the PendingFunds and Reserve amounts.
  - `OffbookBalance` number — Indicates the portion of the account balance which is being held in an off-book account.
  - `Currency` string — 3 character currency code for the balance being returned.
  - `Wallets` object — Breakdown of balances by wallet. Each wallet is an object with its own balances.
    - `0` object
      - `WalletID` string — Unique identifier for the wallet.
      - `WalletName` string — Name of the wallet.
      - `WalletBalance` string — Current wallet balance.
      - `WalletPendingBalance` string — Pending balance for the wallet.
      - `Reserve` string — Reserve amount for the wallet.
      - `RollingReserveNSF` string — NSF rolling reserve for the wallet.
      - `RollingReserveReturns` string — Returns rolling reserve for the wallet.
      - `OffbookBalance` string — Offbook balance for the wallet.

---

[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)