public

GET /v1/pay/invoices/{token}

An invoice, for the person paying it. Unauthenticated.

Tous les points de terminaison public

Toute la documentation pour développeurs

Authentification

Cet point de terminaison est public. Il ne nécessite aucun identifiant ni aucune organisation : c'est ce que notre propre site marketing et nos moteurs de réponse IA lisent.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X GET https://api.zinndigital.com/v1/pay/invoices/{token}

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

No authentication and no session. The payer may have no account here at all; the capability token in the path is the whole authorisation and it reaches exactly one invoice. Every string in the response is already translated into the recipient's locale — the one stored on the document, not the one of whoever's browser opened the link. The page that renders this holds no copy of its own. Every refusal answers with the same sentence whatever the cause — a wrong token, a draft, a withdrawn or an unknown one. Distinguishing them would confirm to a stranger that a token is real, which is the oracle that makes a capability URL worth sweeping.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
token (path)stringOui

Réponse

NomTypeObligatoireQu'est-ce que c'est
referencestringOui
statusstring<sent, paid>Oui
currencystringOui
issue_datestringOui
due_datestringNon
due_date_displaystringNonThe due date in the reader's own convention, already formatted.
buyerobjectOui
linesobject[]Oui
subtotalstringOui
tax_totalstringOui
totalstringOui
total_minorintegerNon
amount_duestringOuiZero once paid. Computed, never stored — a page saying money is due beside a Paid badge is the worst thing this can render.
amount_due_minorintegerOui
notesstringNon
labelsobjectOuiEvery label on the document, in the reader's language.
localestringNon
directionstring<ltr, rtl>Oui
payablebooleanOui

Erreurs que cet point de terminaison peut renvoyer

404 · 429