Skip to main content
GET
Obtenir une Transaction par ID

Vue d’Ensemble

Retourne l’objet transaction complet — la vue canonique d’une découverte ou d’un paiement Bill Payment. Tous les autres endpoints Bill Payment retournent soit ce même objet, soit un identifiant qui pointe vers lui. Parce que la découverte et le paiement sont asynchrones, c’est sur cet endpoint qu’apparaît le résultat réel. Le 200 que vous avez reçu de discover ou de pay confirmait seulement que la requête avait été acceptée.
Une transaction qui appartient à un autre partenaire retourne 404, pas 403. L’API ne confirme jamais l’existence de la transaction de quelqu’un d’autre. Il en va de même entre environnements : une clé sandbox ne peut pas lire une transaction de production, et inversement.

Paramètres de Chemin

string
requis
L’identifiant de transaction retourné par Découvrir les Factures ou Payer une Facture.Une chaîne hexadécimale minuscule de 24 caractères, par exemple 68b2f4c1a7d3e9f204c81a55.

Réponse

boolean
requis
true lorsque la transaction a été trouvée et retournée.
object
requis
L’objet transaction.
object
requis
string
requis
Identifiant de corrélation, également envoyé dans l’en-tête de réponse X-Request-Id. Journalisez-le — c’est la seule chose dont le support a besoin pour tracer une requête.

Exemples

Réponse de Succès

Un paiement terminé :
Une découverte terminée qui a trouvé une facture payable :
Un paiement refusé et remboursé intégralement :

Réponses d’Erreur

L’en-tête X-Access-Token n’a pas été envoyé.
Que faire : envoyez votre clé API dans l’en-tête X-Access-Token à chaque requête.
La clé a été rejetée.
Que faire : vérifiez la clé. Ne réessayez pas avec la même valeur — cela ne se résoudra pas tout seul.
Aucune transaction portant cet identifiant n’appartient à votre compte dans cet environnement.
Que faire : confirmez l’identifiant, et confirmez que vous utilisez la clé de l’environnement dans lequel la transaction a été créée. Un identifiant malformé répond également 404.
Nous n’avons pas pu vérifier votre clé à temps. Ce n’est pas un verdict sur votre clé.
Que faire : attendez le nombre de secondes indiqué dans l’en-tête de réponse Retry-After, puis réessayez la même requête. Ne présentez jamais ceci à votre client comme un problème d’identifiants.
L’API Bill Payment est en maintenance planifiée. Chaque route /v3 répond ceci.
Que faire : respectez Retry-After et réessayez. Les lectures peuvent être répétées sans risque.
Quelque chose a échoué de notre côté.
Que faire : réessayez la lecture. Si le problème persiste, contactez le support avec le requestId.

Cycle de vie du statut

Une transaction est créée par discover, devient payable, puis suit le paiement jusqu’à un état final.
UNKNOWN n’est pas un échec. Ne remboursez jamais votre propre client et ne réessayez jamais le paiement tant qu’une transaction est UNKNOWN — continuez à interroger. Elle se résout en SUCCESS ou REFUNDED.
Stratégie d’interrogation complète →

Champs par statut

Seuls les champs marqués ci-dessous sont présents. Ne supposez pas qu’un champ existe parce que vous l’avez vu dans un autre statut. selectedBill et total apparaissent dès le moment où une facture est sélectionnée pour paiement, ils sont donc absents d’une découverte qui n’a jamais été payée.

Bonnes Pratiques

Branchez sur status

Traitez status comme la seule source de vérité pour le résultat. Ne le déduisez jamais de completedAt ni du statut HTTP de la requête d’origine.

Stockez l'operationId

Sur SUCCESS, persistez operationId et téléchargez le reçu. Ensemble, ils constituent la preuve dont un litige client a besoin.

Journalisez chaque requestId

Conservez requestId à côté de votre propre identifiant de commande. C’est la voie la plus rapide vers une réponse du support.

Interrogez, ne réessayez pas

Une transaction lente n’est pas une transaction perdue. Interrogez cet endpoint au lieu de resoumettre la découverte ou le paiement.

Endpoints Associés

Découvrir les Factures

Démarrer une découverte

Payer une Facture

Payer une facture découverte

Obtenir une Transaction par Référence

Rechercher par votre propre ref

Lister les Transactions

Filtrer et paginer l’historique

Télécharger le Reçu

Obtenir la preuve de paiement

Guide d'Interrogation du Statut

Un interrogateur prêt pour la production