Aller au contenu principal

API Paiements

L'API Paiements gère les opérations de transferts monétaires aux bénéficiaires dans le cadre des cycles de paiement.

Vue d'ensemble

EndpointMéthodeDescription
/api/paiements/by-beneficiaireGETListe des paiements par bénéficiaire
/api/paiements/cyclesGETListe des cycles de paiement
/api/paiements/cyclesPOSTCréer un nouveau cycle
/api/paiements/cycles/{id}/validatePOSTValider un cycle
/api/paiements/cycles/{id}/paiementsGETListe des paiements d'un cycle
/api/paiements/cycles/{id}/executePOSTExécuter un cycle
/api/paiements/cycles/{id}/export-paiements-pdfPOSTExport PDF des paiements
/api/paiements/cycles/{id}/import-reconciliationPOSTImport réconciliation opérateur

Authentification

Tous les endpoints nécessitent une authentification JWT avec le header :

Authorization: Bearer <token>

Rôles requis

EndpointRôle minimum
Liste paiementsROLE_USER
Liste/Créer cyclesROLE_TM_SPECIALIST
Valider cycleROLE_ADMIN
Exécuter cycleROLE_COORDINATEUR

Statuts des paiements

StatutDescription
brouillonPaiement créé, non validé
en_attenteEn attente de validation
valide_rafValidé par le RAF
valide_coordValidé par le Coordinateur
en_coursEnvoyé à l'opérateur
executePaiement réussi
echouePaiement échoué
rejetePaiement rejeté
annulePaiement annulé

Statuts des cycles

StatutDescription
preparationCycle en préparation
valideCycle validé
en_coursPaiements en cours d'exécution
termineCycle terminé
archiveCycle archivé