Skip to navigation

Balances

Retrieve real-time available and current balances for a customer’s checking and savings accounts.

View as Markdown

Overview

The Balances API returns up-to-the-moment balance information for a deposit account. Use it to show customers how much they can spend right now, help them avoid overdrafts, and power budgeting and cash-flow insights.

Each response distinguishes between the available balance (what the customer can spend today) and the current balance (the posted balance, before pending activity).


Get an account balance

1

Authenticate

Obtain an access token with the accounts:read scope.

2

Request the balance

Call the endpoint with the accountRef from Deposit Accounts.

3

Display the result

Show the available balance for spending decisions and the current balance for reconciliation.

{
"accountRef": "acct_884201",
"currency": "USD",
"availableBalance": 2841.55,
"currentBalance": 3010.00,
"pending": 168.45,
"asOf": "2026-04-23T14:32:00Z"
}

Available vs. current balance

Available balance

Funds the customer can use right now — the current balance minus pending transactions and holds.

Current balance

The posted balance at the last update, not accounting for pending activity.

Always use the available balance when helping a customer decide whether they can make a purchase or transfer.


Availability

Balances are available 24/7. During brief nightly processing windows, a balance may reflect the previous business day until posting completes.


Security requirements

Requests require an OAuth 2.0 access token with the accounts:read scope. See the Authentication guide.