Disclaimer

This content is being improved. You may notice some changes in writing style and navigation but no material changes to the API. You can continue working as normal. Thank you for your patience.

Account Balances

Retrieve current and historical account balance information

Fetch current-day balances for multiple accounts
Retrieve historical balance for your trend analysis and audit trails

Retrieve previous day's settled balances
Access balances for up to 200 accounts in different currencies

The Account Balances API lets you retrieve current and historical bank account balances. Balances are the cash settled amount in a given account at the time of the API request.

Attention

Account Balances V2 for BDAs is now available. For more information, see Blockchain Deposit Account (BDA) Balances.

Capabilities

The Account Balances API facilitates fetching current and historical bank account balances and can enable customized integration and reporting.

Near real-time balance retrieval

Can retrieve current-day balances for multiple accounts synchronously.

Prior-day balance retrieval

Can retrieve previous day's settled balances for your end-of-day reconciliation and next-morning reporting.

Historical balance retrieval

Can retrieve up to 31-day historical balance data for your trend analysis, audit trail, and retrospective reporting.

Multi-account querying

Can query balances in different currencies and branches for up to 200 accounts, enabling consolidated treasury views.

Multi-currency support

Supports retrieval of full currency metadata (such as code, description, decimal location) for easy handling of balances in USD, GBP, EUR and other supported currencies.

Four-dimensional balance detail

Access balance records in four distinct amounts: opening and ending available (withdrawable) funds as well as opening and closing ledger (including pending) funds.

Default behavior

Can auto populate missing fields; so no body defaults to current day for all accounts. For example, a startDate without an endDate auto calculates the end as startDate +31 days.

Granular error handling

Can return specific error codes (GCA-001 through GCA-099), thus helping to distinguish between authorization issues, invalid parameters, missing accounts, and system unavailability.

Flexible authentication

Can support both OAuth 2.0 and mutual TLS (mTLS) with separate production and client-testing environments for each.

What you can build

With the Account Balances API, you can build a wide range of reporting and liquidity management solutions.

Automated treasury dashboards

Build a centralized dashboard to view balances across all accounts, currencies, and entities. The dashboard can be refreshed on demand or on schedule using current-day queries.

Threshold-based alerting and automation

Poll current-day balances and trigger automated actions when balances cross defined thresholds such as initiating transfers, sending notifications, and flagging exceptions.

ERP and TMS integration

Replace manual file downloads and portal-based workflows by piping balance data directly into enterprise resource planning or treasury management systems with near real-time API feeds.

Reconciliation engines

Compare opening vs. ending balances and available vs. ledger amounts to automatically detect discrepancies, unposted items, or unexpected movements.

Liquidity management and sweep logic

Move excess available funds into investment accounts or funding accounts that are running low by building intelligent sweep rules using the available vs. ledger distinction.

Regulatory and audit reporting

Create auditable records for compliance purposes by automating daily snapshots of balances with timestamps.