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

# 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

<CardGroup cols={2}>
  <Card title="Zone UEMOA" icon="globe-africa">
    Sénégal, Côte d'Ivoire, Mali, Burkina Faso, Togo, Bénin, Niger, Guinée-Bissau

    **Devise** : XOF (Franc CFA BCEAO)
  </Card>

  <Card title="Zone CEMAC" icon="globe-africa">
    Cameroun, Gabon, Congo, Tchad, RCA, Guinée Équatoriale

    **Devise** : XAF (Franc CFA BEAC)
  </Card>
</CardGroup>

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

1. **Récupérer les méthodes** - `GET /payments/providers`
2. **Initier le paiement** - `POST /payments/initiate`
3. **Rediriger le client** vers `redirectUrl` retourné
4. **Recevoir le webhook** de confirmation
5. **Vérifier le statut** - `GET /payments/status/:transactionId`

## Flux de payout (Décaissement)

### Payout local (Mobile Money ou Virement bancaire)

1. **Vérifier les limites** - `GET /payouts/limits`
2. **Obtenir un devis** - `POST /payouts/quote`
3. **Confirmer le payout** - `POST /payouts/initiate` (avec `quoteId`)
4. **Recevoir le webhook** de confirmation
5. **Vérifier le statut** - `GET /payouts/status/:payoutId`

### Payout international (Virement avec conversion)

1. **Vérifier les corridors** - `GET /payouts/reference/corridors`
2. **Récupérer les motifs** - `GET /payouts/reference/purposes`
3. **Vérifier les documents requis** - `GET /payouts/reference/document-types`
4. **Vérifier les champs requis** - `GET /payouts/reference/methods`
5. **Vérifier les limites** - `GET /payouts/limits`
6. **Obtenir un devis** - `POST /payouts/quote`
7. **Confirmer le payout** - `POST /payouts/initiate` (avec `quoteId`)
8. **Recevoir le webhook** de confirmation
9. **Vérifier le statut** - `GET /payouts/status/:payoutId`

<Tip>
  Le flux quote-based garantit que le marchand connaît le montant exact débité (frais et taux de change inclus) avant de confirmer. Le devis est valide 5 minutes.
</Tip>

## Structure de la documentation

<CardGroup cols={2}>
  <Card title="Démarrage rapide" icon="rocket" href="/guides/quickstart">
    Créez votre premier paiement en quelques étapes
  </Card>

  <Card title="Authentification" icon="key" href="/guides/authentication">
    Clés API, environnements et bonnes pratiques
  </Card>

  <Card title="Référence API" icon="code" href="/api-reference/introduction">
    Spécifications techniques des endpoints
  </Card>

  <Card title="Webhooks" icon="webhook" href="/guides/webhooks">
    Notifications en temps réel
  </Card>
</CardGroup>

## Avant de commencer

1. **Créez un compte** sur [dash-app.caurisflux.com](https://dash-app.caurisflux.com)
2. **Récupérez vos clés API** dans Paramètres > API
3. **Testez en sandbox** avec les clés `pk_test_*` / `sk_test_*`
4. **Passez en production** après validation de votre intégration

## Support

* **Documentation** : [docs.caurisflux.com](https://docs.caurisflux.com)
* **Support technique** : [integration@caurisflux.com](mailto:integration@caurisflux.com)
* **Statut des services** : [status.caurisflux.com](https://status.caurisflux.com)