Overview

The Balance API allows you to check the liquidity of the current client. It is useful as an orchestration API to verify you have liquidity to make calls for our Payments API and Refund based API calls for other transaction types.

Note that the Payments API returns a running balance when used to make an outbound Payment and we recommend relying on a combination of the APIs to help monitor balance and liquidity levels of your account.

Use the Balance API and running balance checks on the Payments API in conjunction with your Top Up PayID to keep your account liquidity topped up.

A timestamp parameter can be supplied to review liquidity at a specific point in time. This can be useful if you need to provide balances at a specific point in time over a period.

API References