public

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

An invoice, for the person paying it. Unauthenticated.

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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.

Parameters

Name	Type	Required	What it is
`token (path)`	`string`	Yes	—

Response

Name	Type	Required	What it is
`reference`	`string`	Yes	—
`status`	`string<sent, paid>`	Yes	—
`currency`	`string`	Yes	—
`rails`	`string[]`	Yes	The payment methods this invoice may be settled on, in the order to show them, and filtered by its currency. Pass the chosen one back as `gateway` on the checkout call. Never…
`issue_date`	`string`	Yes	—
`due_date`	`string`	No	—
`due_date_display`	`string`	No	The due date in the reader's own convention, already formatted.
`buyer`	`object`	Yes	—
`lines`	`object[]`	Yes	—
`subtotal`	`string`	Yes	—
`tax_total`	`string`	Yes	—
`total`	`string`	Yes	—
`total_minor`	`integer`	No	—
`amount_due`	`string`	Yes	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`	Yes	—
`notes`	`string`	No	—
`labels`	`object`	Yes	Every label on the document, in the reader's language.
`locale`	`string`	No	—
`direction`	`string<ltr, rtl>`	Yes	—
`payable`	`boolean`	Yes	—

Errors this endpoint can return

404 · 429

GET /v1/pay/invoices/{token}