Get Available Balance

GET {{baseUrl}}/aggregation/v1/customers/{{customerId}}/accounts/{{transactionAccountId}}/availableBalance

Retrieve the latest cached available and cleared account balances for a customer. Since we update and store balances throughout the day, this is the most accurate balance information available when a connection to a financial institution is unavailable or when a faster response is needed.

Note: this is a premium service, billable per every successful API call. Enrollment is required.

Supported regions:

HEADERS

RESPONSES

status: OK

{"id":1005061234,"availableBalance":173.47,"availableBalanceDate":1607450357,"clearedBalance":222.25,"clearedBalanceDate":1607450357,"aggregationStatusCode":98272143,"currency":"AUD","realAccountNumberLast4":"5678"}