Overview
This API endpoint allows an application or service to retrieve the current available balance of a given account in a specified currency.
- Purpose: Retrieve real-time account balances for reconciliation, reporting, or business logic.
- Target Audience: All developers and businesses integrating with BobPlus Africa APIs.
Quickstart: Fetch Account Balance
- Obtain your Bearer Token and generate the required signature.
- Send a GET request to the balance endpoint with the required parameters.
- Parse the response to get the account balance and details.
Endpoint Reference
| HTTP Method | GET |
|---|
| Endpoint URL | /api/v2/wallet/{wallet_no}/{currency} |
|---|
| Base URL | https://prod-url-here |
|---|
| Description | Fetch the current balance for a specific wallet and currency. |
|---|
URL Parameters
| Parameter | Description | Required | Example |
|---|
| wallet_no | The account ID (e.g., "00201XXXX14605") | Yes | 00201XXXX14605 |
| currency | The currency code (e.g., "KES" for Kenya) | Yes | KES |
Request Headers
| Header | Type | Description | Required |
|---|
| Authorization | string | Bearer token required for API authentication. | Yes |
| Signature | string | SHA-256 signature. Concatenate wallet_no+currency, sign with your private key, and Base64 encode. | Yes |
Example API Request
curl --location 'https://prod-url-here/api/v2/wallet/08xxxxx17/KES' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Signature: XXCCCXXXXXXXXX'
Success Response
| Field | Type | Description |
|---|
| success | boolean | Indicates if the request was successful. |
| message | string | Descriptive message regarding the request outcome. |
| data.account.number | string | The account number for which the balance was retrieved. |
| data.account.name | string | The name associated with the account. |
| data.account.currency | string | The currency of the account balance. |
| data.account.balance | float | The available balance in the account. |
{
"success": true,
"message": "Successfully fetched",
"data": {
"uuid": "f93be5e9-0b9c-4968-8cf6-2fe4f274e594",
"account": {
"number": "33815317",
"name": "Bobplus Africa",
"currency": "USD",
"balance": 1000000.00
},
"last_update": "2025-02-10 18:11:57"
}
}
Security Best Practices
- Always use HTTPS for all API requests.
- Keep your private key secure and never share it.
- Verify the signature on the server side for every request.
Support & Feedback
For help, contact support@bobplus.africa.
Feedback on this documentation? Let us know.
Terms of Use & Legal
By using this API, you agree to our Terms of Service and Privacy Policy. Do not share sensitive data or credentials.