public
POST /v1/pay/invoices/{token}/checkout
Start paying an invoice on our checkout. Unauthenticated.
אימות
נקודת קצה זו היא ציבורית. היא אינה דורשת שורת פרטי זיהוי ואינה דורשת ארגון – זהו המידע שאתרי השיווק ומנועי התשובות מבוססי ה-AI שלנו קוראים.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/pay/invoices/{token}/checkout \
-H "Content-Type: application/json" \
-d '{ }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Joins the platform's ordinary money path at the front. It creates the recipient's lightweight account here and not before — an order is org-scoped and so is the invoice document its payment produces — mints one order for the document (idempotent, so a double tap reaches the same order and the same payment intent), and starts the charge on our own gateway. The response carries whichever credential the chosen rail needs: client_token is a card intent's client secret for the browser SDK, redirect_url is an approval page for PayPal or a crypto invoice. settled: true means the total was zero and the order completed with no gateway at all. ⛔ Nothing here captures money and nothing here decides an order is paid. The gateway's webhook does both, exactly as it does for every other order on the platform.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
token (path) | string | כן | — |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
gateway | string | לא | The rail to settle on. Omit to follow the platform default. |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
status | string | כן | — |
settled | boolean | כן | — |
amount_minor | integer | כן | — |
currency | string | כן | — |
client_token | string | לא | A card intent's client secret, for the browser SDK. It authorises confirming this one intent and nothing else. |
redirect_url | string | לא | An approval page to send the payer to (PayPal, a crypto invoice). |
action_kind | string | לא | setup means no card is on file and client_token is a SetupIntent secret — confirm it, then call /confirm. Anything else is a live charge's own action. |
setup_intent_id | string | לא | The SetupIntent the card form is mounted against, echoed back for the /confirm call. An id, not a secret: the server re-reads it from the gateway and refuses it unless the… |
שגיאות שנקודה קצה זו עשויה להחזיר
404 · 409 · 429 · 503