​

Get Account Balance

curl --request GET \
  --url https://api.kairosafrika.com/v1/external/account/balance \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'x-api-version: 2025-08-01'

​

Responses

• 200 OK: Returns account balance information.
• 401 Unauthorized: Invalid or missing API key.
• 403 Forbidden: Insufficient permissions to access balance information.

​

Response Example

{
  "statusCode": "200",
  "statusMessage": "Current account balance",
  "transactionId": "01K6N2G1N9TR1WARA6TG4DVVYH",
  "sequenceNo": "01K6N2G1N90FJ7T7THSJ4JKY22",
  "data": {
    "id": 387,
    "credit": 169,
    "intlCredit": 0,
    "intlTotalAmount": "0",
    "userId": {
      "id": 387,
      "name": "oheneba akwasi-poku",
      "username": null,
      "phone": "0500469610"
    }
  },
  "timestamp": "2025-10-03T12:59:33.930Z"
}

​

Response Fields

• statusCode (string): HTTP status code.
• statusMessage (string): Status message description.
• transactionId (string): Unique transaction identifier.
• sequenceNo (string): Sequence number for the request.
• data (object): Account balance data.
  • id (integer): Account ID.
  • credit (number): Current local credit balance.
  • intlCredit (number): Current international credit balance.
  • intlTotalAmount (string): Total international amount.
  • userId (object): User information.
    • id (integer): User ID.
    • name (string): User’s full name.
    • username (string|null): Username (can be null).
    • phone (string): User’s phone number.
• timestamp (string): ISO 8601 timestamp of the response.