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

# List your balances

> One balance per service, country and currency (Congo - Kinshasa has CDF and USD). A balance is `"0.00"` until
you collect there. A balance only pays out to mobile money numbers of its own country.
Services counted: `active` ones, plus `pending_review` ones in test mode.




## OpenAPI

````yaml /openapi.yaml get /mobile-money/balances
openapi: 3.1.0
info:
  title: KemyPay API
  version: '1.0'
  description: >
    KemyPay lets you collect mobile money payments in 12 African countries
    through one API, with one balance per

    service, country and currency.


    Every request is authenticated with a secret API key (`sk_live_…` or
    `sk_test_…`) and must come from one of

    your allowed IP addresses. Responses use the same envelope: `{ "success":
    true, "data": …, "meta": … }`, or

    `{ "success": false, "error": { "code", "message", "details" }, "meta": …
    }`.


    Collections, quotes and operator prediction are in **beta**: they are being
    rolled out in production.
  contact:
    name: KemyPay Support
    email: hi@kemypay.com
servers:
  - url: https://api.kemypay.com/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Catalog
    description: Countries, operators, prices and service categories
  - name: Services
    description: Your services (one per app or business activity), validated by our team
  - name: Collections
    description: Collect a payment from a customer's mobile money account (beta)
  - name: Balances
    description: One balance per service, country and currency
paths:
  /mobile-money/balances:
    get:
      tags:
        - Balances
      summary: List your balances
      description: >
        One balance per service, country and currency (Congo - Kinshasa has CDF
        and USD). A balance is `"0.00"` until

        you collect there. A balance only pays out to mobile money numbers of
        its own country.

        Services counted: `active` ones, plus `pending_review` ones in test
        mode.
      operationId: listBalances
      parameters:
        - name: service
          in: query
          required: false
          description: Only the balances of this service (its code).
          schema:
            type: string
            format: uuid
        - name: country
          in: query
          required: false
          description: Only the balances of this country (ISO 3166-1 alpha-3).
          schema:
            type: string
            example: CMR
      responses:
        '200':
          description: Balances
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Balance'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/CountryError'
components:
  schemas:
    Balance:
      type: object
      properties:
        service_code:
          type: string
          format: uuid
          example: 019a8f2e-4c1b-7d3a-9e55-2b6f0c1d8a47
        service_name:
          type: string
          example: Afroyamo
        country:
          type: string
          example: CMR
        name:
          type: string
          example: Cameroon
        currency:
          type: string
          example: XAF
        available:
          type: string
          example: '0.00'
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
          example: null
    Meta:
      type: object
      properties:
        request_id:
          type: string
          example: a4f8e2c1b3d97056
        timestamp:
          type: string
          format: date-time
          example: '2026-10-29T10:00:00+00:00'
        mode:
          type: string
          enum:
            - test
            - live
          example: live
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
              example: VALIDATION_ERROR
            message:
              type: string
              example: Some fields of the payment are missing or invalid.
            details:
              type: object
              additionalProperties: true
              example:
                phone_number: >-
                  Required: the mobile money number with the country code,
                  digits only, for example 237670000000.
        meta:
          $ref: '#/components/schemas/Meta'
  responses:
    NotFound:
      description: >-
        `RESOURCE_NOT_FOUND`: no service or payment with this code in your
        account and mode.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CountryError:
      description: >-
        `VALIDATION_ERROR` (not an alpha-3 code) or `COUNTRY_NOT_SUPPORTED` (not
        available for your account).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error:
              code: COUNTRY_NOT_SUPPORTED
              message: Mobile money is not available in GHA for your account.
            meta:
              request_id: a4f8e2c1b3d97056
              timestamp: '2026-10-29T10:00:00+00:00'
              mode: live
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret API key: `sk_live_…` (real money) or `sk_test_…` (test
        mode).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.