> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc-business.easytransfert.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Présentation de l'API

> Découvrez l'API KAYBIC AFRICA  et ses fonctionnalités principales

## Objectif de l'API KAYBIC AFRICA

L'API KAYBIC AFRICA  est une API REST qui permet aux marchands d'initier et de suivre leurs transactions.

<CardGroup cols={2}>
  <Card title="Transactions" icon="exchange" color="#3c60ef">
    Cash-in/Cash-out
  </Card>

  <Card title="Notifications" icon="bell" color="#3c60ef">
    Réception des statuts via IPN
  </Card>

  <Card title="Statut" icon="check" color="#3c60ef">
    Vérifier le statut d'une transaction
  </Card>

  <Card title="Notifications" icon="wallet" color="#3c60ef">
    Consulter le solde du marchand
  </Card>
</CardGroup>

## Services couverts

L'API couvre exclusivement les services suivants :

### Transferts d'argent Mobile Money

Initiation de transactions Mobile Money via un point d'accès unique.

**Type des transactions :**

* **Cashin** : déplacer de l'argent du wallet du marchand vers le wallet mobile money du client
* **Cashout** : déplacer de l'argent du wallet mobile money du client vers le wallet du marchand

<Info>
  Chaque transaction est identifiée par un `transaction_id` unique généré par KAYBIC AFRICA.
</Info>

### Suivi des transactions

Deux mécanismes complémentaires sont disponibles :

<AccordionGroup>
  <Accordion title="IPN (Webhook) - mécanisme recommandé" icon="webhook">
    Notification automatique envoyée à l'URL fournie lors de l'initiation de la transaction.

    Transmission de l'état final de la transaction :

    * **SUCCESSFUL** : Transaction réussie
    * **FAILED** : Transaction échouée
  </Accordion>

  <Accordion title="Consultation du statut (usage limité)" icon="search">
    Endpoint dédié pour récupérer l'état d'une transaction.

    <Warning>
      À utiliser uniquement en cas de non-réception de l'IPN. L'interrogation répétée peut entraîner un blocage.
    </Warning>
  </Accordion>

  <Accordion title="Consultation du solde">
    Endpoint permettant de consulter le solde du marchand.

    <Note>
      Il faut noter que le solde est aussi disponible depuis le dashboard du marchand
    </Note>
  </Accordion>
</AccordionGroup>

<CardGroup cols={2} />

## Avantages clés

<AccordionGroup>
  <Accordion title="Sécurité" icon="shield">
    * Authentification par clé API
    * Accès restreint aux partenaires autorisés
    * Communication sécurisée via HTTPS obligatoire
  </Accordion>

  <Accordion title="Traçabilité" icon="file-invoice">
    * Identifiant unique pour chaque transaction
    * Champs custom\_data pour le reconciliation métier
    * Historique et suivi via IPN et endpoint de statut
  </Accordion>

  <Accordion title="Scalabilité" icon="chart-bar">
    * Architecture adaptée aux volumes élevés
    * Support multi-opérateurs sans changement d'intégration
    * Compatible avec des systèmes distribués et micro-services
  </Accordion>
</AccordionGroup>
