Get Balance
Retrieve the current wallet balance for your organisation.
Endpoint
GET /v1/balance/Authentication: Bearer API key (see Authentication)
Request
No request body or query parameters required.
curl https://api.talkntalk.africa/v1/balance/ \
-H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"Response
200 OK
{
"organisation": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"balance": "1250.00",
"currency": "KES",
"retrieved_at": "2026-05-20T09:30:00.123456+00:00"
}| Field | Type | Description |
|---|---|---|
organisation | string (UUID) | Your organisation's unique identifier |
balance | string (decimal) | Current wallet balance |
currency | string | Always KES |
retrieved_at | string (ISO 8601) | Timestamp of when the balance was computed |
The balance reflects all completed transactions only. Pending transactions (e.g. an in-flight SMS send) are not deducted until confirmed.
Code Examples
curl https://api.talkntalk.africa/v1/balance/ \
-H "Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"Error Responses
| Status | Meaning |
|---|---|
401 Unauthorized | Missing or invalid API key |
{
"detail": "Invalid or revoked API key."
}