Skip to navigation
API ReferenceAccounts

Get balance

Returns the balance of an account your business opened. Balances are formatted naira strings from the bank.

Authentication

AuthorizationBearer

Your Halo partner API key, sent as Authorization: Bearer <key>.

Request

This endpoint expects an object.
accountNumberstringRequired
An account number your business opened.
computewithdrawableBalancestring or nullOptional
Accepted but not used.

Response

Success.
statusbooleanOptional
messagestringOptional
dataobjectOptional
status_codeintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error