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
| Endpoint | Methode | Description |
|---|---|---|
/api/cycles/{id}/export | GET | Export des paiements d'un cycle |
/api/cycles/{id}/export/st | GET | Export format ST (operateur) |
/api/export/paiements | GET | Export general des paiements |
/api/export/paiements/reconciliation | GET | Export pour reconciliation |
Export d'un cycle
Endpoint
GET /api/cycles/{id}/export
Parametres
| Parametre | Type | Description |
|---|---|---|
format | string | csv ou xlsx (defaut: csv) |
statut | string | Filtrer par statut de paiement |
Reponse
Fichier CSV/Excel contenant :
| Colonne | Description |
|---|---|
| Reference | Reference du paiement |
| Beneficiaire | Nom du beneficiaire |
| Code beneficiaire | Code unique |
| Telephone | Numero de telephone |
| Montant | Montant a payer |
| Mode paiement | Mobile Money, Virement, etc. |
| Compte | Numero de compte ou mobile |
| Statut | En attente, Paye, Echoue |
| Date | Date 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
| Colonne | Format | Description |
|---|---|---|
| CODE_BENEFICIAIRE | String | Code unique |
| NOM | String | Nom de famille |
| PRENOM | String | Prenom |
| TELEPHONE | String | Format +245XXXXXXXXX |
| MONTANT | Integer | Montant en XOF |
| MODE | String | MOBILE_MONEY ou VIREMENT |
Export general
Endpoint
GET /api/export/paiements
Parametres
| Parametre | Type | Description |
|---|---|---|
dateDebut | date | Date de debut |
dateFin | date | Date de fin |
cycle | UUID | Filtrer par cycle |
programme | UUID | Filtrer par programme |
region | UUID | Filtrer par region |
statut | string | Filtrer par statut |
format | string | csv 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
| Colonne | Description |
|---|---|
| id | ID du paiement |
| reference | Reference unique |
| beneficiaire_id | ID du beneficiaire |
| telephone | Numero normalise |
| montant | Montant |
| statut_actuel | Statut dans le systeme |
| date_soumission | Date de soumission |
Limites
| Type | Limite |
|---|---|
| Nombre de lignes | 50,000 max par export |
| Periode | 12 mois max |
| Taille fichier | 50 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
| Code | HTTP | Description |
|---|---|---|
NO_DATA | 404 | Aucune donnee a exporter |
TOO_MANY_RECORDS | 400 | Trop de lignes (>50000) |
INVALID_FORMAT | 400 | Format non supporte |
FORBIDDEN | 403 | Permission insuffisante |