3 endpoints
Remboursements
Rembourser tout ou partie d'un paiement abouti, avec motif et votre propre référence — débité du solde et tracé comme une opération liée au paiement d'origine.
Les intitulés et descriptions d'endpoints viennent du contrat OpenAPI, en anglais — ils ne peuvent pas diverger de l'API.
En clair
Rendre l'argent d'une vente, en totalité ou en partie, proprement.
Quand l'utiliser
Dès qu'une commande est annulée, retournée ou contestée. Un remboursement partiel est possible, et plusieurs remboursements peuvent se succéder tant que le total ne dépasse pas le paiement d'origine.
Comment l'intégrer
- 1Créez le remboursement en citant l'opération d'origine et votre référence de remboursement.
- 2La référence sert de clé d'idempotence : rejouer le même appel ne rembourse pas deux fois.
- 3Suivez l'aboutissement par webhook — un remboursement n'est pas instantané côté banque.
- GET
/v1/refundsLister les remboursements - POST
/v1/refundsCréer un remboursement - GET
/v1/refunds/{reference}Récupérer un remboursement
Lister les remboursements
Renvoie vos remboursements pour l'environnement de la clé, du plus récent au plus ancien, sous forme de Page paginée. Filtrage facultatif par statut (PENDING, SUCCESS, FAILED).
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
status | enum | query | Optionnel | Uniquement les remboursements dans ce statut.Valeurs PENDINGSUCCESSFAILED |
pageable | Pageable | query | Requis |
Créer un remboursement
Rembourse un paiement, en totalité ou en partie (refundAmount). Identifiez le paiement par operationId ou externalId. Idempotent sur refundReference : rejouer une référence déjà exécutée renvoie le remboursement existant (200) sans nouveau débit ; une nouvelle référence renvoie 202 Accepted le temps du règlement.
Schéma · RefundPaymentRequest
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
operationId | integer (int64) | body | Optionnel | |
externalId | string | body | Optionnel | |
refundReference | string | body | Requis | |
refundAmount | number | body | Optionnel | |
reason | string | body | Requis | |
note | string | body | Optionnel | |
metadata | object | body | Optionnel |
Récupérer un remboursement
Récupère un remboursement par votre refundReference ou par le refundId de la plateforme.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
reference | string | path | Requis | Votre refundReference ou le refundId de la plateforme. |
Une question sur l'intégration ?
Notre équipe technique répond aux intégrateurs, du premier appel en sandbox jusqu'à la mise en production.