API Details
Use this request to return the balance on a specific account. The response will return two balance amounts:
- BOOKED_BALANCE - the balance on the account at a given point in time.
- AVAILABLE_BALANCE - the balance amount that may be used to initiate Credit Transfer payments.
Understanding Available Funds in the Balance Details API
Available Funds represent the amount that can be used from an account at any given time. These are calculated as:
Available Funds = Booked Balance - Float - Balance Reservations |
Note that:
- Booked Balance: The total balance recorded in the account.
- Float: Funds that are temporarily unavailable e.g. an amount set aside to cover potential R-transactions..
- Balance Reservations: Amounts reserved for specific purposes, such as maintaining a minimum balance.
How Reservations Work
Reservations may be in place in order to:
- Maintain a minimal balance requirements.
- Hold the required funds for Credit Transfers to be executed.
Pending payments do not block funds. However, funds are temporarily reserved during the processing phase to ensure account stability, verify sufficient balance, and prevent overdrafts.
Behavior During Payment Processing
Standard Payments:
- Funds are checked and reserved at the moment the CT is created, ensuring enough funds are available and preventing parallel transactions from causing negative balances.
- For payments in a
READY_FOR_EXPORT
status, the reservation period is extremely short (approximately 1 second), so the difference between the Booked Balance and Available Funds is negligible.
Express Payments:
- Reservations last slightly longer, as they depend on receiving an acknowledgment from the payment scheme. However, this duration remains brief.
##Key Points
- Reservations ensure safe and consistent fund management during transaction processing.
- Pending payments do not affect the available balance.
- Differences between Booked Balance and Available Funds are typically minimal and transient, particularly for standard payments.
dateuntil
parameter. This takes a Unix Epoch timestamp and defaults to the current dateWhen working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.
LIVE https://api.nuapay.com SANDBOX https://sandbox.nuapay.com/
If you haven't done so already and would like to do some testing, please Request Sandbox Access
Important: Endpoints and Webhooks may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).