Skip to main content
GET
/
balances
/
currency
/
{currency}
cURL
curl --request GET \
  --url https://dev-api.hyperail.io/api/v1/balances/currency/{currency} \
  --header 'Authorization: Bearer <token>'
[
  {
    "accountId": "c1fba25a-a36b-479c-b17d-64dbaf3ba32c",
    "currency": "GHS",
    "balance": 3,
    "availableBalance": 3
  }
]

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer token

Path Parameters

​
currency
string
required

The unique identifier of the account currency.

Response

Returns all balance by account ID

​
accountId
string<uuid>
Example:

"c1fba25a-a36b-479c-b17d-64dbaf3ba32c"

​
currency
string
Example:

"GHS"

​
balance
number<float>
Example:

3

​
availableBalance
number<float>
Example:

3