Account Balance
Test URL
GEThttps://uat.finserve.africa/v3-apis/account-api/v3.0/accounts/balances/{countryCode}/{accountId}
Live URL
GEThttps://api.finserve.africa/v3-apis/account-api/v3.0/accounts/balances/{countryCode}/{accountId}
This web service enables an application or service retrieve the current and available balance of an account
⚠️ Environment Notice: Use the
uatURL for testing only. Switch to the live URL for production.
📘 Supported Banks and Countries
We currently support statements from Equity Bank (KE, SS, TZ, UG, DRC RW). One Web Service to
ruleaccess them all :muscle:. More banks, Card associations & Mobile wallets will be coming soon.
200 Success Response Schema
| Field Name | Field Type | Field Description |
|---|---|---|
status | bool | Response status |
code | number | Response code |
message | string | Response message |
data.currency | string | account currency |
data.balances | array | array of balances |
amount | string | account balance |
type | string | account balance type. |
Example Request
⚠️
In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.
Signature Formulae e.g KE1450160649886
countryCode+accountIdURL Parameters
| Parameter | Description | Required | Example |
|---|---|---|---|
{countryCode} | The country code (e.g., "KE" for Kenya) | Yes | KE |
{accountId} | The account ID (e.g., "00201XXXX14605") | Yes | 00201XXXX14605 |
Example Request
curl -X GET \
-H 'Authorization: Bearer {{access_token}}' \
-H 'signature: {{signature}}' \
-L 'https://uat.finserve.africa/v3-apis/account-api/v3.0/accounts/balances/KE/00201XXXX14605'Example Response
Example Response
{
"status": true,
"code": 0,
"message": "success",
"data": {
"balances": [
{
"amount": "5655.58",
"type": "Available"
},
{
"amount": "5655.58",
"type": "Current"
}
],
"currency": "KES"
}
}Error Codes
| Status Code | Description |
|---|---|
401 | Unauthorized – Invalid token |
404 | Not Found – Invalid endpoint |
500 | Internal Server Error |