Capay Global PG
Guide développeurs

Comment intégrer une API mobile money

Encaissez le mobile money depuis votre application avec une seule API REST : testez avec les clés sandbox, créez un encaissement, puis confirmez-le par un webhook signé.

Mis à jour le 7 octobre 2026

Créer un encaissement dans la sandbox

POST /v1/collections
curl https://api.capayglobal.com/v1/collections \
  -H "Authorization: Bearer sk_test_XXXXXXXXXXXX" \
  -H "Idempotency-Key: 9f0c7a52-2b1e-4c55-9a43-1f6e0d2b8c11" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "5000",
    "currency": "XAF",
    "country": "CM",
    "method": "mobile_money",
    "msisdn": "237670000000",
    "merchant_reference": "order_1042"
  }'

Conventions à connaître

  • Les montants sont des chaînes décimales avec une devise explicite, jamais des nombres flottants. Les devises sans décimales comme le XAF n'ont pas de partie fractionnaire.
  • Chaque réponse, succès ou erreur, porte un request_id à communiquer au support.
  • Les appels qui créent de l'argent exigent un Idempotency-Key : rejouer la même clé renvoie le résultat d'origine au lieu d'un second débit.

Étape par étape

  1. 1Obtenez votre clé sandboxInscrivez-vous et créez une application dans le tableau de bord. Les clés sandbox commencent par sk_test_ et n'atteignent que le simulateur, jamais un réseau réel.
  2. 2Créez un encaissementEnvoyez POST /v1/collections avec le montant en chaîne décimale, la devise, le pays, la méthode mobile_money, le numéro du payeur (msisdn) et votre propre merchant_reference. Ajoutez un en-tête Idempotency-Key pour qu'une nouvelle tentative ne débite jamais deux fois.
  3. 3Laissez le payeur validerL'encaissement revient en attente pendant que le payeur valide la demande sur son téléphone.
  4. 4Confirmez par un webhookEnregistrez un point de terminaison webhook. Chaque livraison est signée par un en-tête X-Capay-Signature : vérifiez-le avant de marquer une commande comme payée.
  5. 5Passez en productionAprès la vérification de l'entreprise, passez à votre clé sk_live_. L'environnement dépend uniquement de la clé : il n'y a aucun autre interrupteur.

Questions fréquentes

Existe-t-il une sandbox gratuite ?

Oui. La sandbox est gratuite et illimitée, ouverte dès l'inscription, et simule des payeurs qui réussissent, échouent ou laissent expirer.

Quels pays l'API couvre-t-elle ?

Les encaissements sont actifs dans ces pays : Cameroun, Gabon, Ouganda, Kenya, Ghana, Tanzanie, Côte d’Ivoire, Sénégal, Congo-Brazzaville, Bénin, Rwanda, Congo-Kinshasa, Zambie, Sierra Leone, Burkina Faso, Mali, Togo, Guinée, Niger et Nigeria. La méthode disponible dans chaque pays figure sur sa page de couverture.

Comment savoir qu'un paiement a réussi ?

Par le webhook signé, ou en relisant l'encaissement avec GET /v1/collections/{id}. Ne marquez jamais une commande comme payée sur la seule redirection du navigateur.

Combien cela coûte-t-il ?

Aucuns frais d'installation ni abonnement. Les encaissements sont facturés à partir de 1,99 % par encaissement réussi, et chaque réponse de l'API porte le détail complet des frais.

Guides associés

Comment créer un lien de paiementUn lien de paiement est une page de paiement que vous partagez partout : WhatsApp, réseaux sociaux, SMS, e-mail ou facture. Sans site web et sans code.Comment vérifier la signature des webhooksChaque webhook de Capay Global est signé. Vérifier la signature tient en quelques lignes et empêche quiconque de simuler un événement de paiement réussi.Comment passer aux paiements réelsLa sandbox s'ouvre dès l'inscription. Cette liste couvre ce qui doit être en place avant que de l'argent réel circule.

Commencez dans la sandbox dès aujourd'hui

Gratuite, illimitée et ouverte dès l'inscription. Les paiements réels s'ouvrent après la vérification de votre entreprise.

Créer un compte gratuitLire la documentation développeursVoir les tarifs