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

# Check balance

> Retrieve your available account balance.



## OpenAPI

````yaml /openapi/multicountry-sms.json get /api/userAccountBalance
openapi: 3.0.3
info:
  title: Beem Multicountry SMS & SMPP API
  version: 1.0.0
  description: >-
    HTTP API for sending international SMS messages via the Beem Messaging
    Platform, checking account balance, and receiving inbound messages and
    delivery reports via callback webhooks. SMPP integration is documented in
    the guides.
  contact:
    name: Beem
    url: https://beem.africa
    email: support@beem.africa
servers:
  - url: https://api.blsmsgw.com:8443
    description: Messaging Platform — send API
security: []
tags: []
paths:
  /api/userAccountBalance:
    get:
      summary: Check balance
      description: Retrieve your available account balance.
      operationId: checkBalance
      responses:
        '200':
          description: Account balance retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
              example:
                account: test
                balance: '1234.567'
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceError'
              examples:
                authenticationFailed:
                  summary: Authentication failed
                  value:
                    error: Authentication failed
        '403':
          description: API permission denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceError'
              examples:
                noApiPermission:
                  summary: No API permission
                  value:
                    error: You do not have api permission
      security:
        - basicAuth: []
      servers:
        - url: https://www.blsmsgw.com/portal
          description: Portal API
components:
  schemas:
    BalanceResponse:
      type: object
      properties:
        account:
          type: string
        balance:
          type: string
    BalanceError:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Account username and password sent as HTTP Basic Authentication.

````