Balances

The Blockchain Deposit Account (BDA) Balances API retrieves current and/or historical balances from BDAs (Blockchain Deposit Accounts), returning detailed information about various balance types associated with your account.

You can use this API for customized integration and reporting via flexible date specifications, such as relative date type and date range, and multiple balance type options, such as "Interim available" and "Interim booked".

When to use Balances

Reporting

View both historical and current balances.

Cash flow forecasting

Project expected balances based on current levels and planned future activities.

Amount-based event triggers

Execute predefined actions when specified balance thresholds are met

Liquidity

Determine that there are sufficient funds in your account to support payment activities.

Sweeping

Capture balances across accounts to facilitate funds consolidation.

How Balances works

To get started, send an empty GET request to the /accounts/balances endpoint, which defaults to retrieving a list of current day balances for all eligible accounts configured with your API credentials. Then, form a customized POST request and get current and historical balances for your specified accounts.

For more detailed information on how to initiate a Balances request, refer to the how to get balances tutorial.

Note

Take into account the time zone in which the account is located when requesting balance data, as this is a factor when processing current day and prior day relative date parameters.
In response data, balances are returned sorted by date, in chronological order.

Availability

Balances resource availability
Regions	Markets
North America (NA)	United States

Next Steps

Review the resources page.
Learn how to get balances.