public

GET /v1/pay/invoices/{token}

An invoice, for the person paying it. Unauthenticated.

Gbogbo àwọn public endpoints

Gbogbo àwọn ìwé àṣẹ olùgbékalẹ̀ àgbékalẹ̀

Ìfàṣẹ́pọ̀

Ojú-wọ̀n yìí jẹ́ ti gbogbo ènìyàn. Kò gba àmì ìdánimọ̀ kankan tàbí àgbájọ kankan — ohun tí ojú-wọ̀n ìpolówó wa àti àwọn ẹ̀rọ ìdáhùn AI ǹkà kọ́ ni.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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.

Àwọn ìpìlẹ̀

OrúkọIruTí a nílòKini o jẹ
token (path)stringBẹẹni

Idahun

OrúkọIruTí a nílòKini o jẹ
referencestringBẹẹni
statusstring<sent, paid>Bẹẹni
currencystringBẹẹni
issue_datestringBẹẹni
due_datestringBẹẹkọ
due_date_displaystringBẹẹkọThe due date in the reader's own convention, already formatted.
buyerobjectBẹẹni
linesobject[]Bẹẹni
subtotalstringBẹẹni
tax_totalstringBẹẹni
totalstringBẹẹni
total_minorintegerBẹẹkọ
amount_duestringBẹẹniZero once paid. Computed, never stored — a page saying money is due beside a Paid badge is the worst thing this can render.
amount_due_minorintegerBẹẹni
notesstringBẹẹkọ
labelsobjectBẹẹniEvery label on the document, in the reader's language.
localestringBẹẹkọ
directionstring<ltr, rtl>Bẹẹni
payablebooleanBẹẹni

Awọn aṣiṣe ti ibudo ipari yii le da pada

404 · 429