Aller au contenu principal

Refunds

Les remboursements sont actuellement exposés principalement à travers les opérations de paiement à portée marchande.

Objet Refund​

{
  "id": "re_abc123",
  "object": "refund",
  "amount": 5000,
  "currency": "xof",
  "payment_intent": "pi_xyz789",
  "status": "succeeded",
  "reason": "requested_by_customer",
  "created": 1708300800
}

Famille de routes implémentée​

Les opérations actuelles de remboursement sont documentées sous la famille de routes marchandes :

  • POST /api/v1/merchant/payments/{id}/refund
  • GET /api/v1/merchant/payments/{id}/refunds

Des chemins marchands compatibles hérités peuvent aussi être disponibles sous api/merchant/*.

Créer un remboursement pour un paiement​

POST /api/v1/merchant/payments/{id}/refund
ParamètreTypeRequisDescription
amountintegerMontant à rembourser
reasonstringduplicate, fraudulent ou requested_by_customer

L’identifiant de paiement fait partie de la route et se réfère à la ressource de paiement marchand à rembourser.

Lister les remboursements d’un paiement​

GET /api/v1/merchant/payments/{id}/refunds

Cette opération retourne les remboursements associés à un paiement marchand spécifique.

Note d’intégration​

À ce stade, la documentation ne doit pas présenter les remboursements comme une famille de ressources publique indépendante tant que cette famille de routes n’est pas explicitement implémentée et exposée.