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

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-service-source
string
default:HyperRails
required

Identifies the calling service

Example:

"HyperRails"

Response

Returns all balances

​
accountId
string<uuid>
Example:

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

​
currency
string
Example:

"GHS"

​
balance
number<float>
Example:

3

​
availableBalance
number<float>
Example:

3