Skip to main content
Your account balances are available at any time through the HUB2 API.
See the endpoint in the API reference.

Request

Sample request:
Query parameters (all optional):
  • currency: the currency to fetch, here XOF.
  • date: the date and time (UTC, ISO 8601) at which to compute the balance, here 2023-10-01T00:00:00.000Z. Defaults to the current time.
  • accountType: restricts the response to specific accounts: collection, transfer or transfer-irt. Repeat the parameter or pass a comma-separated list (for example accountType=collection,transfer). When omitted, every account you hold is returned.

Response

Sample response:
  • availableBalance: funds immediately available on the account.
  • reservedBalance (transfer accounts): funds reserved for transfers being processed. Depending on their outcome, part of these funds can be released and become available again.
  • amount (collection account): deprecated, use availableBalance instead.
The response can also contain a transferIrtAccount array (international transfers), with the same fields as transferAccount. An account you do not hold, or one excluded by accountType, is absent from the response. For zero-decimal currencies such as XOF and XAF, amounts are whole units (100 = 100 FCFA).