Skip to main content
GET
Télécharger le Reçu

Vue d’ensemble

Diffuse le reçu du facturier pour une facture payée. C’est le seul endpoint Bill Payment qui ne retourne pas de JSON en cas de succès — le corps de la réponse est le fichier brut. Les reçus n’existent que pour les transactions dont le status est SUCCESS. Tout le reste — une transaction encore en cours, une transaction échouée, une transaction remboursée, une transaction appartenant à un autre partenaire — répond avec l’enveloppe d’erreur JSON habituelle et un 404 NOT_FOUND.
Le receiptUrl d’une transaction réussie correspond exactement à cet endpoint. Il requiert toujours votre en-tête X-Access-Token : ce n’est donc pas un lien que vous pouvez donner à un client ou intégrer dans un e-mail. Téléchargez les octets, stockez-les et servez-les depuis votre propre système.

Paramètres de chemin

string
requis
L’identifiant de la transaction. Une chaîne hexadécimale en minuscules de 24 caractères, issue de Obtenir une Transaction par ID ou de n’importe quelle liste.

Réponse

En cas de succès, le corps est le fichier lui-même. Lisez les en-têtes de réponse pour savoir ce que vous avez reçu.
header
requis
Le type de média du fichier : application/pdf, image/png ou image/jpeg. Tout ce que nous ne pouvons pas identifier est servi en application/octet-stream.Faites toujours votre branchement sur cet en-tête plutôt que de supposer un PDF.
header
requis
attachment; filename="..." — le nom de fichier suggéré, avec l’extension qui correspond à Content-Type.
header
requis
La taille du fichier en octets.
header
requis
private, max-age=86400. Le reçu appartient à un seul partenaire ; ne le mettez jamais dans un cache partagé ou public.
header
requis
nosniff.
header
requis
Identifiant de corrélation de cette requête. Il n’y a pas de corps JSON en cas de succès : cet en-tête est donc le seul endroit où il apparaît — journalisez-le.

Exemples

Chaque exemple vérifie le statut avant d’écrire quoi que ce soit, et prend l’extension du fichier dans la réponse plutôt que de la supposer.

Réponse de succès

Le corps est binaire. Les en-têtes ressemblent à ceci :

Réponses d’erreur

Les erreurs sont retournées en JSON, dans la même enveloppe que pour tous les autres endpoints.
La clé était absente ou a été rejetée.
Que faire : vérifiez la clé avec Valider la Clé API.
Soit la transaction ne vous appartient pas dans cet environnement, soit elle n’a pas de reçu.
Un reçu n’existe qu’une fois qu’un paiement a atteint SUCCESS. Télécharger pendant que la transaction est en PROCESSING retourne cette erreur, tout comme une transaction FAILED ou REFUNDED — ni l’une ni l’autre n’a de reçu, car aucun paiement n’a été mené à terme.Que faire : lisez d’abord la transaction, et ne téléchargez que lorsque status vaut SUCCESS et que receiptUrl est présent.
Nous n’avons pas pu vérifier votre clé à temps, ou l’API est en maintenance planifiée.
Que faire : respectez l’en-tête Retry-After (5 secondes) et réessayez. Le téléchargement peut être répété sans risque.
Le reçu n’a pas pu être lu.
Que faire : réessayez une fois, puis contactez le support avec le requestId. Le paiement lui-même n’est pas affecté — la transaction reste en SUCCESS.

Télécharger au bon moment

Récupérez le reçu dès qu’un paiement atteint SUCCESS, dans la même étape que celle qui enregistre le succès de votre côté.
Stockez les octets, pas l’URL. receiptUrl requiert votre clé API : un lien stocké est donc inutile pour votre client et dangereux à partager.

Bonnes pratiques

Télécharger une Fois, Stocker pour Toujours

Conservez le reçu avec votre propre enregistrement de commande. C’est le document avec lequel se règle un litige client.

Lire Content-Type

Le reçu est un PDF ou une image selon le facturier. Prenez l’extension dans l’en-tête.

Ne Jamais Exposer l'URL

Servez les reçus depuis votre propre système, derrière votre propre authentification.

L'Associer à operationId

Le reçu est le document ; operationId est la référence. Stockez les deux.

Endpoints associés

Obtenir une Transaction par ID

Où apparaissent receiptUrl et operationId

Lister les Transactions

Retrouvez tout ce qui a été payé sur une période

Payer une Facture

Le paiement qui l’a produit

Reçus et Rapprochement

Stocker et rapprocher les reçus