Envoyer et suivre des paiements
Paiement unitaire
Créez votre paiement avec POST /paiements-envoyes et le scope paiement.write. Choisissez votre exemple dans la référence API, opération paiementCreer, puis renseignez les champs selon le schéma.
Lorsque confirmation vaut true, le parcours se déroule en deux temps : initiation avec recherche d’alias, puis confirmation explicite par PUT /paiements-envoyes/{txId}/confirmations. Vérifiez les informations retournées avant de confirmer.
Le business génère le txId. Conservez-le avec l’end2endId retourné par le participant. Une réponse à la création ne dispense pas de suivre le statut final du paiement.
Consultation et rapprochement
| Besoin | Méthode et chemin |
|---|---|
| Lister les paiements envoyés | GET /paiements-envoyes |
| Consulter un paiement envoyé | GET /paiements-envoyes/{txId} |
| Lister les paiements reçus | GET /paiements-recus |
| Consulter un paiement reçu | GET /paiements-recus/{txId} |
| Vérifier un paiement par sa référence de bout en bout | GET /paiements/{end2endId} |
Ces consultations nécessitent paiement.read. Utilisez les filtres et paramètres déclarés par chaque opération dans la référence. Vous pouvez aussi suivre les résultats par webhook.
Paiements en masse
Créez le lot avec POST /paiements-groupes. L’instructionId identifie le lot ; chaque transaction possède son propre txId. Consultez GET /paiements-groupes/{instructionId} et, pour un parcours avec confirmation, confirmez avec PUT /paiements-groupes/{instructionId}/confirmations lorsque les vérifications sont terminées.
Analysez les résultats individuels : un lot peut contenir des transactions rejetées. La liste des lots est accessible par GET /paiements-groupes. Les scopes sont paiement_groupe.write et paiement_groupe.read.
Retours et annulations
| Action | Méthode et chemin |
|---|---|
| Retourner un paiement reçu | PUT /paiements/{end2endId}/retours |
| Demander l’annulation d’un paiement envoyé | POST /paiements/{end2endId}/annulations |
| Répondre à une demande d’annulation reçue | PUT /paiements/{end2endId}/annulations/reponses |
Une demande d’annulation ne garantit pas un retour de fonds. Suivez son résultat par consultation et notification. Consultez les conditions, scopes et schémas de chaque opération avant l’appel ; après une réponse incertaine, appliquez le parcours de reprise.