public

GET `/v1/pay/invoices/{token}`

An invoice, for the person paying it. Unauthenticated.

Аутентификация

Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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`	Да	—

Ответ

Имя	Тип	Обязательно	Что это
`reference`	`string`	Да	—
`status`	`string<sent, paid>`	Да	—
`currency`	`string`	Да	—
`issue_date`	`string`	Да	—
`due_date`	`string`	Нет	—
`due_date_display`	`string`	Нет	The due date in the reader's own convention, already formatted.
`buyer`	`object`	Да	—
`lines`	`object[]`	Да	—
`subtotal`	`string`	Да	—
`tax_total`	`string`	Да	—
`total`	`string`	Да	—
`total_minor`	`integer`	Нет	—
`amount_due`	`string`	Да	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_minor`	`integer`	Да	—
`notes`	`string`	Нет	—
`labels`	`object`	Да	Every label on the document, in the reader's language.
`locale`	`string`	Нет	—
`direction`	`string<ltr, rtl>`	Да	—
`payable`	`boolean`	Да	—

Ошибки, которые может возвращать этот эндпоинт

404 · 429

GET /v1/pay/invoices/{token}