Skip to main content
GET
Account Balance

Overview

Returns the balances held by your organisation across every currency you have been enabled for. Most accounts hold a single balance in their primary currency; organisations enabled for multiple regions receive one entry per currency.
Use this endpoint to display available funds before initiating a vending or messaging request, and to reconcile wallet activity after transactions complete.

Response Fields

string
The registered name of your organisation.
array
One entry per account currency held by your organisation.

Example Response

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successfully retrieved account balances

gatewayStatus
string
Example:

"00"

gatewayMessage
string
Example:

"Successfully Processed"

requestReference
string
Example:

"bpr_req_a1b2c3d4e5f6"

data
object