HOhoneycoin

Get Balances

Changed on

Returns the authenticated account's balances as separate currency and country records. Use GET /api/sandbox/b2b/users/balances with a sandbox bearer token for sandbox data. Both environments return the same fields. Optional country and currency filters are combined; omit both to return all existing balance records. Filter values are trimmed and converted to uppercase. The bearer token determines the account; no publicKey or userId parameter is required. An empty result returns HTTP 200 with success:true and data:[]. Records with a global balance have country:null; omit the country filter to include them.

get/api/b2b/users/balances

Request

  • Base URL
    https://api-v2.honeycoin.app
  • URL
    https://api-v2.honeycoin.app/api/b2b/users/balances
  • Auth
    API key in header Authorization

Query parameters

countrystring
Example:KE

Two-letter country code. Surrounding whitespace is trimmed and letters are normalized to uppercase. Omit to include all countries and global balances.

currencystring
Example:KES

Alphanumeric currency code with at least three characters, such as KES or USDC. Surrounding whitespace is trimmed and letters are normalized to uppercase.

Response

Balance records matching the filters, or an empty array when none match.

successtrue required

Example response

{
  "data": [
    {
      "currency": "KES",
      "availableBalance": 1250.5,
      "country": "KE"
    }
  ]
}

Changes