Embedded Payments

Overview

When requesting balances via the API, you may encounter transactions that are pending and not yet booked. To accommodate this, the API allows you to retrieve different balance types, each reflecting a specific inclusion or exclusion of pending transactions. The available balance types are:

The available balance types are as follows
Balance Type	Description
INTERIM_AVAILABLE	Available balance at the time of the request, including pending debits and holds. Reflects the total funds currently accessible for use.
INTERIM_BOOKED or LEDGER BALANCE	Current balance at the time of the request; may not include transactions not yet completed.
INTERIM_EXPECTED	Available balance at the time of the request, including pending credits.

You can retrieve balances for the following account types:

TRANSACTION_ACCOUNT
DEFAULT
LIMITED_DDA
LIMITED_DDA_PAYMENTS
MANAGEMENT
PROCESSING
CLIENT_OFFSET
PROCESSING_OFFSET

Next steps

Get balance

Learn more about retrieving real time account balances using the Get balance endpoint in the Balances guide.