> ## 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 credit balance

> Retrieve available credit balance for a product. Set app_name to AIRTIME, USSD, BPAY, or another registered product name.



## OpenAPI

````yaml /openapi/airtime.json get /credit-balance
openapi: 3.0.3
info:
  title: Beem Airtime API
  version: 1.0.0
  description: >-
    Airtime top-up, transaction status, credit balance, and customer callbacks.
    Transfer and status endpoints are served by the Airtime API; credit balance
    is served by the shared Topup service (use app_name=AIRTIME or USSD).
  contact:
    name: Beem
    url: https://beem.africa
    email: support@beem.africa
servers:
  - url: https://apiairtime.beem.africa
    description: Airtime API — transfer & transaction status
  - url: https://apitopup.beem.africa/v1
    description: Topup API — credit balance (shared across products)
security: []
tags: []
paths:
  /credit-balance:
    get:
      summary: Check credit balance
      description: >-
        Retrieve available credit balance for a product. Set app_name to
        AIRTIME, USSD, BPAY, or another registered product name.
      operationId: getCreditBalance
      parameters:
        - name: app_name
          in: query
          schema:
            description: >-
              Product identifier. Use AIRTIME for Airtime API, USSD for USSD
              billing, BPAY for payments.
            enum:
              - AIRTIME
              - USSD
              - BPAY
              - SMS
              - OTP
              - CHAT
              - BROADCAST
              - EMG
              - MOJA
            type: string
          required: true
        - name: user_id
          in: query
          schema:
            description: Admin only — query balance for another user
            anyOf:
              - type: string
              - type: number
                format: float
          required: false
        - name: country
          in: query
          schema:
            description: Optional ISO country code filter
            type: string
          required: false
        - name: currency
          in: query
          schema:
            description: Optional ISO currency code filter
            type: string
          required: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      credit_bal:
                        description: Available credit balance for the requested product
                        type: string
                      credit_level:
                        description: Credit level threshold for low-balance alerts
                        anyOf:
                          - type: string
                          - type: number
                            format: float
                      sms_reminder:
                        description: Whether SMS low-balance reminders are enabled
                        type: boolean
                      email_reminder:
                        description: Whether email low-balance reminders are enabled
                        type: boolean
                      allow_postpaid_limit:
                        description: Whether postpaid limit billing is enabled
                        type: boolean
                      postpaid_limit:
                        description: Maximum postpaid credit limit, if enabled
                        anyOf:
                          - type: string
                          - type: number
                            format: float
                      moja_session_expiry:
                        description: MOJA session expiry setting in minutes
                        anyOf:
                          - type: string
                          - type: number
                            format: float
                    additionalProperties: false
                    required:
                      - credit_bal
                additionalProperties: false
                required:
                  - data
        default:
          description: Successful response
      security:
        - basicAuth: []
        - accessToken: []
      servers:
        - url: https://apitopup.beem.africa/v1
          description: Topup API — use app_name=AIRTIME or USSD
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Beem API credentials: API key as username, API secret as password.'
    accessToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Access token only. Send as Authorization: <token> — do not use a Bearer
        prefix.

````