public

GET /v1/pay/invoices/{token}

An invoice, for the person paying it. Unauthenticated.

Minden public végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Ez a végpont nyilvános. Nem igényel hitelesítő adatot és szervezetet sem – ezt olvassa a saját marketingoldalunk és az MI-válaszadó motorunk is.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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éterek

NévTípusKötelezőMi ez
token (path)stringIgen

Válasz

NévTípusKötelezőMi ez
referencestringIgen
statusstring<sent, paid>Igen
currencystringIgen
issue_datestringIgen
due_datestringNem
due_date_displaystringNemThe due date in the reader's own convention, already formatted.
buyerobjectIgen
linesobject[]Igen
subtotalstringIgen
tax_totalstringIgen
totalstringIgen
total_minorintegerNem
amount_duestringIgenZero once paid. Computed, never stored — a page saying money is due beside a Paid badge is the worst thing this can render.
amount_due_minorintegerIgen
notesstringNem
labelsobjectIgenEvery label on the document, in the reader's language.
localestringNem
directionstring<ltr, rtl>Igen
payablebooleanIgen

Hibák, amelyeket ez a végpont visszaadhattatlan

404 · 429