> ## 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.

# Lister les soldes

> Un solde par service, par pays et par devise (le Congo - Kinshasa en a deux : CDF et USD). Un solde vaut `"0.00"` tant que
vous n'avez rien encaissé. Un solde ne paie que des numéros mobile money de son propre pays.
Services comptés : les services `active`, plus ceux en `pending_review` en mode test.




## OpenAPI

````yaml fr/openapi.yaml GET /mobile-money/balances
openapi: 3.1.0
info:
  title: API KemyPay
  version: '1.0'
  description: >
    KemyPay vous permet d'encaisser des paiements mobile money dans 12 pays
    d'Afrique avec une seule API, avec un solde par

    service, par pays et par devise.


    Chaque requête est authentifiée par une clé API secrète (`sk_live_…` ou
    `sk_test_…`) et doit venir d'une de

    vos adresses IP autorisées. Les réponses utilisent la même enveloppe : `{
    "success": true, "data": …, "meta": … }`, ou

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


    Les encaissements, le calcul de prix et la devinette de l'opérateur sont en
    **bêta** : ils sont en cours de déploiement en production.
  contact:
    name: KemyPay Support
    email: hi@kemypay.com
servers:
  - url: https://api.kemypay.com/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Catalog
    description: Pays, opérateurs, prix et catégories de service
  - name: Services
    description: Vos services (un par application ou activité), validés par notre équipe
  - name: Collections
    description: Encaisser un paiement depuis le compte mobile money d'un client (bêta)
  - name: Balances
    description: Un solde par service, par pays et par devise
paths:
  /mobile-money/balances:
    get:
      tags:
        - Balances
      summary: Lister vos soldes
      description: >
        Un solde par service, par pays et par devise (le Congo - Kinshasa en a
        deux : CDF et USD). Un solde vaut `"0.00"` tant que

        vous n'avez rien encaissé. Un solde ne paie que des numéros mobile money
        de son propre pays.

        Services comptés : les services `active`, plus ceux en `pending_review`
        en mode test.
      operationId: listBalances
      parameters:
        - name: service
          in: query
          required: false
          description: Seulement les soldes de ce service (son code).
          schema:
            type: string
            format: uuid
        - name: country
          in: query
          required: false
          description: Seulement les soldes de ce pays (ISO 3166-1 alpha-3).
          schema:
            type: string
            example: CMR
      responses:
        '200':
          description: Soldes
          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` : aucun service ni paiement avec ce code dans votre
        compte et ce mode.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CountryError:
      description: >-
        `VALIDATION_ERROR` (pas un code alpha-3) ou `COUNTRY_NOT_SUPPORTED` (pas
        disponible pour votre compte).
      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: >-
        Votre clé API secrète : `sk_live_…` (argent réel) ou `sk_test_…` (mode
        test).

````

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