> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kairosafrika.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Account Balance

> Retrieve the current credit balance for your account

# Get Account Balance

This endpoint allows you to retrieve the current credit balance for your account.

**Endpoint:** `GET /v1/external/account/balance`

<RequestExample>
  ```bash cURL theme={null}
  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'
  ```
</RequestExample>

## Responses

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

## Response Example

```json theme={null}
{
  "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.


## OpenAPI

````yaml GET /v1/external/account/balance
openapi: 3.0.3
info:
  title: Kairos Afrika SMS API
  description: >-
    Send SMS messages through the Kairos Afrika platform. Switch between staging
    and production environments using the server dropdown.
  version: 1.0.0
  contact:
    name: Kairos Afrika Support
    email: support@kairosafrika.com
servers:
  - url: https://api.kairosafrika.com
    description: Sms API Base URL
security:
  - apiKeyAuth: []
    apiSecretAuth: []
paths:
  /v1/external/account/balance:
    get:
      tags:
        - Account
      summary: Get Account Balance
      description: Retrieve the current credit balance for your account
      operationId: getAccountBalance
      parameters:
        - name: x-api-version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2025-08-01'
          description: API version header (required for full JSON response)
          example: '2025-08-01'
      responses:
        '200':
          description: Account balance retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalanceResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: 12d72d1c-08f7-4821-a05c-05fef961553f
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: 12d72d1c-08f7-4821-a05c-05fef961553f
components:
  schemas:
    AccountBalanceResponse:
      type: object
      properties:
        statusCode:
          type: string
          description: HTTP status code
          example: '200'
        statusMessage:
          type: string
          description: Status message
          example: Current account balance
        transactionId:
          type: string
          description: Unique transaction identifier
          example: 01K6N2G1N9TR1WARA6TG4DVVYH
        sequenceNo:
          type: string
          description: Sequence number
          example: 01K6N2G1N90FJ7T7THSJ4JKY22
        data:
          type: object
          properties:
            id:
              type: integer
              description: Account ID
              example: 387
            credit:
              type: number
              description: Current local credit balance
              example: 169
            intlCredit:
              type: number
              description: Current international credit balance
              example: 0
            intlTotalAmount:
              type: string
              description: Total international amount
              example: '0'
            userId:
              type: object
              properties:
                id:
                  type: integer
                  description: User ID
                  example: 387
                name:
                  type: string
                  description: User's full name
                  example: oheneba akwasi-poku
                username:
                  type: string
                  nullable: true
                  description: Username
                  example: null
                phone:
                  type: string
                  description: User's phone number
                  example: '0500469610'
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp
          example: '2025-10-03T12:59:33.930Z'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key for authentication
    apiSecretAuth:
      type: apiKey
      in: header
      name: x-api-secret
      description: API Secret for authentication

````