Aller au contenu principal

Export des Paiements

Cette page documente les fonctionnalites d'export des donnees de paiement.

Vue d'ensemble

Le module d'export permet de :

  • Generer des fichiers pour les operateurs de paiement
  • Exporter des rapports de paiement
  • Telecharger des listes de beneficiaires

Endpoints d'export

EndpointMethodeDescription
/api/cycles/{id}/exportGETExport des paiements d'un cycle
/api/cycles/{id}/export/stGETExport format ST (operateur)
/api/export/paiementsGETExport general des paiements
/api/export/paiements/reconciliationGETExport pour reconciliation

Export d'un cycle

Endpoint

GET /api/cycles/{id}/export

Parametres

ParametreTypeDescription
formatstringcsv ou xlsx (defaut: csv)
statutstringFiltrer par statut de paiement

Reponse

Fichier CSV/Excel contenant :

ColonneDescription
ReferenceReference du paiement
BeneficiaireNom du beneficiaire
Code beneficiaireCode unique
TelephoneNumero de telephone
MontantMontant a payer
Mode paiementMobile Money, Virement, etc.
CompteNumero de compte ou mobile
StatutEn attente, Paye, Echoue
DateDate du paiement

Export format ST (operateur)

Endpoint

GET /api/cycles/{id}/export/st

Description

Format specifique pour transmission aux operateurs de transfert d'argent.

Structure du fichier

CODE_BENEFICIAIRE;NOM;PRENOM;TELEPHONE;MONTANT;MODE
BEN-OIO-2025-001;DIALLO;Mamadou;+245955123456;15000;MOBILE_MONEY
BEN-OIO-2025-002;SANE;Fatou;+245966789012;15000;MOBILE_MONEY

Colonnes

ColonneFormatDescription
CODE_BENEFICIAIREStringCode unique
NOMStringNom de famille
PRENOMStringPrenom
TELEPHONEStringFormat +245XXXXXXXXX
MONTANTIntegerMontant en XOF
MODEStringMOBILE_MONEY ou VIREMENT

Export general

Endpoint

GET /api/export/paiements

Parametres

ParametreTypeDescription
dateDebutdateDate de debut
dateFindateDate de fin
cycleUUIDFiltrer par cycle
programmeUUIDFiltrer par programme
regionUUIDFiltrer par region
statutstringFiltrer par statut
formatstringcsv ou xlsx

Exemple

GET /api/export/paiements?dateDebut=2026-01-01&dateFin=2026-06-30&format=xlsx

Reponse

Fichier Excel avec tous les paiements correspondant aux filtres.


Export pour reconciliation

Endpoint

GET /api/export/paiements/reconciliation

Description

Format specifique pour la reconciliation avec les fichiers retour operateur.

Structure

ColonneDescription
idID du paiement
referenceReference unique
beneficiaire_idID du beneficiaire
telephoneNumero normalise
montantMontant
statut_actuelStatut dans le systeme
date_soumissionDate de soumission

Limites

TypeLimite
Nombre de lignes50,000 max par export
Periode12 mois max
Taille fichier50 Mo max

Formats de sortie

CSV

  • Encodage : UTF-8
  • Separateur : Point-virgule (;)
  • Guillemets : Pour les champs texte

Excel (XLSX)

  • Format : Office Open XML
  • Feuille unique
  • En-tetes en gras

Workflow d'export operateur

┌────────────────────┐
│ 1. Valider le cycle│
└─────────┬──────────┘

┌────────────────────┐
│ 2. Export ST │
└─────────┬──────────┘

┌────────────────────┐
│ 3. Transmettre a │
│ l'operateur │
└─────────┬──────────┘

┌────────────────────┐
│ 4. Recevoir fichier│
│ retour │
└─────────┬──────────┘

┌────────────────────┐
│ 5. Import reconci- │
│ liation │
└────────────────────┘

Exemple de code

Export CSV avec filtres

curl -X GET "https://api.example.com/api/export/paiements?cycle=xxx&format=csv" \
-H "Authorization: Bearer TOKEN" \
-o paiements_cycle.csv

Export Excel

curl -X GET "https://api.example.com/api/cycles/xxx/export?format=xlsx" \
-H "Authorization: Bearer TOKEN" \
-o paiements_cycle.xlsx

Codes d'erreur

CodeHTTPDescription
NO_DATA404Aucune donnee a exporter
TOO_MANY_RECORDS400Trop de lignes (>50000)
INVALID_FORMAT400Format non supporte
FORBIDDEN403Permission insuffisante