Get Account Balance

Get account balance details for a specific sub-account before and after top-up in both NGN and GHS currency.

GET https://api.spotflow.co/api/v1/balances/accounts/:accountNumber/balance

Headers

authorization String	Bearer SECRET_KEY Include your secret key in the request header as a Bearer token for authorization. Unauthorized requests will result in a 401 HTTP status code.

Query Parameters

accountNumber Integer	This filters by the account number created specifically for a sub account. You can either use the account number for a specific sub account or your main account.

Sample Response with NGN Sub Account Number:

200 OK

{
    "accountNumber": "8213714164",
    "currency": "NGN",
    "balance": 0.00,
    "availableBalance": 0.00,
    "accountTag": "sub-account",
    "parentAccountNumber": "0958094143"
}

Sample Response with NGN Main Account Number:

200 OK

{
    "accountId": "43bbf6b7-6bf0-4aec-b145-eef4d3b29a75",
    "balance": 80700.00,
    "availableBalance": 80700.00,
    "accountTag": "main-account"
}

Sample Response with GHS Sub Account Number:

200 OK

{
    "accountNumber": "1985812247",
    "currency": "GHS",
    "balance": 0.00,
    "availableBalance": 0.00,
    "accountTag": "sub-account",
    "parentAccountNumber": "0958094143"
}

Sample Response with GHS Main Account Number:

200 OK

{
    "accountNumber": "7706438396",
    "currency": "GHS",
    "balance": 3.00,
    "availableBalance": 3.00,
    "accountTag": "main-account"
}