Introduction
Documentation technique de l'API CaurisFlux
À propos de cette documentation
Cette documentation s'adresse aux développeurs qui intègrent l'API CaurisFlux dans leurs applications. Elle couvre l'ensemble du cycle de vie des paiements : initiation, confirmation, webhooks et gestion des erreurs.
Public cible :
- Développeurs backend intégrant les paiements
- Équipes techniques évaluant la solution
- Architectes concevant des flux de paiement
Qu'est-ce que CaurisFlux ?
CaurisFlux est une infrastructure de paiement unifiée pour l'Afrique. Elle permet de collecter des paiements (Mobile Money, cartes internationales) et d'effectuer des décaissements vers l'Afrique, l'Europe et les États-Unis.
Collecte de paiements (Pay-in)
| Type | Fournisseurs | Zones |
|---|---|---|
| Mobile Money | Wave, Orange Money, MTN MoMo, Moov Money, Free Money, Airtel Money | UEMOA, CEMAC |
| Cartes Internationales | Visa, Mastercard, American Express | Mondial |
| Cartes Régionales | GIM-UEMOA | Zone UEMOA |
Décaissements (Pay-out)
| Corridor | Destinations | Devises |
|---|---|---|
| Mobile Money | 14 pays UEMOA/CEMAC | XOF, XAF |
| SEPA | 36 pays européens | EUR |
| USA | États-Unis | USD |
| Swift | 180+ pays | Multi-devises |
Couverture géographique
Zone UEMOA
Sénégal, Côte d'Ivoire, Mali, Burkina Faso, Togo, Bénin, Niger, Guinée-Bissau
Devise : XOF (Franc CFA BCEAO)
Zone CEMAC
Cameroun, Gabon, Congo, Tchad, RCA, Guinée Équatoriale
Devise : XAF (Franc CFA BEAC)
Ce que vous pouvez faire avec l'API
- Collecter des paiements : Acceptez les paiements Mobile Money et carte via checkout ou API directe
- Effectuer des décaissements (payouts) : Envoyez des fonds vers des comptes Mobile Money ou bancaires (locaux et internationaux)
- Gérer les remboursements : Initiez des remboursements totaux ou partiels
- Suivre les transactions : Consultez l'historique et les statistiques
- Recevoir des notifications : Configurez des webhooks pour les événements en temps réel
Environnements
| Environnement | URL de base | Préfixe clés |
|---|---|---|
| Sandbox | https://sandbox-api.caurisflux.com/api/v1 | pk_test_ / sk_test_ |
| Production | https://prod-api.caurisflux.com/api/v1 | pk_live_ / sk_live_ |
Les deux environnements utilisent des clés API distinctes. Les transactions sandbox n'entraînent aucun mouvement de fonds.
Flux de paiement (Collect)
- Récupérer les méthodes -
GET /payments/providers - Initier le paiement -
POST /payments/initiate - Rediriger le client vers
redirectUrlretourné - Recevoir le webhook de confirmation
- Vérifier le statut -
GET /payments/status/:transactionId
Flux de payout (Décaissement)
Payout local (Mobile Money ou Virement bancaire)
- Vérifier les limites -
GET /payouts/limits - Créer le payout -
POST /payouts/initiate - Recevoir le webhook de confirmation
- Vérifier le statut -
GET /payments/status/:payoutId
Payout international (Virement avec conversion)
- Vérifier les corridors -
GET /payouts/reference/corridors - Récupérer les motifs -
GET /payouts/reference/purposes - Vérifier les documents requis -
GET /payouts/reference/document-types - Vérifier les champs requis -
GET /payouts/reference/methods - Vérifier les limites -
GET /payouts/limits - Créer le payout -
POST /payouts/initiate - Recevoir le webhook de confirmation
- Vérifier le statut -
GET /payments/status/:payoutId
Structure de la documentation
Avant de commencer
- Créez un compte sur dash-app.caurisflux.com
- Récupérez vos clés API dans Paramètres > API
- Testez en sandbox avec les clés
pk_test_*/sk_test_* - Passez en production après validation de votre intégration
Support
- Documentation : docs.caurisflux.com
- Support technique : integration@caurisflux.com
- Statut des services : status.caurisflux.com