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

> Retrieve available Bpay (Payments Collection) credit balance for your account. Set app_name to BPAY.



## OpenAPI

````yaml /openapi/payments-collection.json get /credit-balance
openapi: 3.0.3
info:
  title: Beem Payments Collection API
  version: 1.0.0
  description: >-
    Bpay Payments Collection: customer-hosted payment callbacks and credit
    balance checks via the shared Topup service (app_name=BPAY).
  contact:
    name: Beem
    url: https://beem.africa
    email: support@beem.africa
servers:
  - url: https://apitopup.beem.africa/v1
    description: Topup API — credit balance
security: []
tags: []
paths:
  /credit-balance:
    get:
      summary: Check Bpay credit balance
      description: >-
        Retrieve available Bpay (Payments Collection) credit balance for your
        account. Set app_name to BPAY.
      operationId: checkBpayCreditBalance
      parameters:
        - name: app_name
          in: query
          schema:
            description: Product identifier. Must be BPAY for Payments Collection billing.
            enum:
              - AIRTIME
              - USSD
              - BPAY
              - SMS
              - OTP
              - CHAT
              - BROADCAST
              - EMG
              - MOJA
            type: string
            default: BPAY
            example: BPAY
          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
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - credit_bal
                    properties:
                      credit_bal:
                        type: string
                        description: Available Bpay credit balance.
              examples:
                success:
                  summary: Bpay credit balance
                  value:
                    data:
                      credit_bal: '5300.0000'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                missingAuth:
                  summary: Missing authorization header
                  value:
                    error: No authorization headers
        '401':
          description: Invalid authentication
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                  message:
                    type: string
              examples:
                invalidAuth:
                  summary: Invalid authentication
                  value:
                    code: 120
                    message: Invalid Authentication Parameters
        default:
          description: Successful response
      security:
        - basicAuth: []
        - accessToken: []
      servers:
        - url: https://apitopup.beem.africa/v1
          description: Topup API — credit balance
        - url: https://dev-apitopup.beem.africa/v1
          description: Staging — credit balance
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.

````