Reference API

Suivre l'état d'une demande de contrat

GET /api/v1/payments/dexpay/:reference — récupérer le statut métier d'une demande partenaire.

But

Consulter l'état courant d'une demande de contrat créée via l'endpoint partenaire.

La section ci-dessous est branchée sur la spec OpenAPI réelle. Elle expose les paramètres, les schémas de réponse et le playground d'exécution.

Résumé rapide

  • Méthode: GET
  • Route: /api/v1/payments/dexpay/{reference}
  • Clé utile: reference
  • Usage: suivi front, réconciliation, fallback si webhook manqué

Quand utiliser cet endpoint

Cette route est utile dans trois cas:

  1. verifier l etat d une demande juste apres redirection paiement,
  2. corriger un webhook manque ou arrive trop tard,
  3. permettre a un back-office partenaire de relire la situation exacte d un dossier.

Statuts métier

contractStatusSignification
PENDING_PAYMENTEn attente de paiement.
PAYMENT_FAILEDPaiement annulé/en échec.
ISSUANCE_IN_PROGRESSPaiement validé, émission en cours.
ACTIVEContrat émis.
ISSUANCE_FAILEDPaiement validé mais émission échouée.
REFUNDEDPaiement remboursé.

ISSUANCE_FAILED est un cas critique: le client a paye mais aucun contrat n est encore emis. Branche un alerting immediat et remonte l information au support.

Bonnes pratiques

  • Interroger cette route avec la reference stockee lors de la creation.
  • Ne pas poller agressivement: prefere une relecture ponctuelle ou un fallback apres webhook manque.
  • Conserver le dernier contractStatus connu dans ta base pour simplifier l UX partenaire.

Référence interactive

GET
/api/v1/payments/dexpay/{reference}
AuthorizationBearer <token>

In: header

Path Parameters

reference*string

Response Body

curl -X GET "http://localhost:3210/api/v1/payments/dexpay/AUTO_CLASSIC_1712345678901_ab12cd34ef56"
Empty

Voir aussi

On this page