Initier et suivre un transfert
Le parcours principal comporte une recherche du payé, sa présentation au client, puis une confirmation. Conservez les identifiants retournés et le même contexte participant pendant tout le parcours.
Parcours en deux temps
| Étape | Appel sous /api/v1/{participantCode} | Résultat à exploiter |
|---|---|---|
| Rechercher par alias | POST /transfer-initiations avec alias | Initiation, id, endToEndId, payé si trouvé |
| Rechercher par compte | Même route avec accountId et creditorAgent | Vérification asynchrone ; ne pas confirmer avant son résultat |
| Lire la recherche | GET /transfer-initiations/{id} | status et données de payee |
| Confirmer après accord du client | POST /transfer-initiations/{id}/confirmation | 202, identifiant du transfert, consultation dans Location |
| Suivre | GET /transfers/{id} | Résultat métier et comptable |
alias et accountId sont des alternatives. La confirmation reprend l’EndToEndId et les données du payé issus de la recherche. Le corps de confirmation porte notamment type, businessReference, amount, debtorAccount et channel ; les champs complémentaires dépendent du parcours et du profil des clients. Consultez son schéma dans la référence, puis utilisez les données réelles de votre environnement.
La devise est XOF ; si currency est omis, le cœur utilise XOF. Les données disponibles du payeur peuvent être complétées par le CBS. Les données explicitement fournies restent soumises aux contrôles métier.
Route directe
POST /transfers sert les canaux qui réalisent eux-mêmes la recherche préalable. Pour un transfert inter-participants, réutilisez l’endToEndId d’une recherche aboutie et des données du payé cohérentes avec elle. Une recherche absente ou une incohérence est refusée ; ne contournez pas ce refus en créant un nouvel ordre.
Un transfert entre deux comptes de notre participant est traité par le CBS selon la décision projet correspondante ; aucune vérification distante PI ne le précède.
Cette route accepte Idempotency-Key facultatif. Réutilisez la même clé avec les mêmes données lors d’un rejeu de la même demande. Voir erreurs et reprises.
Paiement de masse
/bulk-transfer-initiations permet de rechercher les payés du lot avant confirmation. Consultez le lot, attendez son état READY, puis confirmez par POST /bulk-transfer-initiations/{batchId}/confirmation. Le résultat doit être suivi par élément : un lot peut être partiellement exécuté. /bulk-transfers constitue la route directe du lot pour les canaux réalisant leur propre préparation.
Après le HTTP 202
L’acceptation signifie que le cœur a pris en charge la demande. Elle ne signifie ni débit définitif ni paiement réussi. Consultez les statuts et la chronologie du transfert. Les parcours nominaux Postman B.1 couvrent les différentes issues.