public

GET /v1/pay/invoices/{token}

An invoice, for the person paying it. Unauthenticated.

Усі кінцеві точки public

Уся документація для розробників

Автентифікація

Ця кінцева точка є публічною. Вона не потребує жодних облікових даних чи організації — це те, що читають наш власний маркетинговий сайт та пошукові системи на основі штучного інтелекту.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

НазваТипОбов'язковеЩо це таке
token (path)stringТак

Відповідь

НазваТипОбов'язковеЩо це таке
referencestringТак
statusstring<sent, paid>Так
currencystringТак
issue_datestringТак
due_datestringНі
due_date_displaystringНіThe due date in the reader's own convention, already formatted.
buyerobjectТак
linesobject[]Так
subtotalstringТак
tax_totalstringТак
totalstringТак
total_minorintegerНі
amount_duestringТакZero once paid. Computed, never stored — a page saying money is due beside a Paid badge is the worst thing this can render.
amount_due_minorintegerТак
notesstringНі
labelsobjectТакEvery label on the document, in the reader's language.
localestringНі
directionstring<ltr, rtl>Так
payablebooleanТак

Помилки, які може повертати ця кінцева точка

404 · 429