public
GET /v1/pay/invoices/{token}
An invoice, for the person paying it. Unauthenticated.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/pay/invoices/{token}ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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