reseller
POST /v1/wallet/top-ups
Add credit to your balance.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה billing.payment.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/wallet/top-ups \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "amount_minor": <integer>, "currency": <string> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Charged on your provider's own payment account when you are a reseller's client, and on Zinn®'s when you buy directly. The credit is written when the payment captures: a crypto invoice awaiting confirmation (pending) or a card awaiting 3-D Secure (requires_action) returns 201 with that status and no balance change, because the money has not arrived. 422 when your provider has not finished connecting a payment account — the charge is refused rather than settled somewhere else. ⚖️ Credit bought from Zinn® is never refundable, including on account closure, and never expires (owner ruling 2026-08-22). Call GET /v1/wallet/top-ups/estimate first and show the customer what they will actually receive — on a crypto rail that can be less than the amount quoted, because we credit what settles rather than what was asked for. Requires billing.payment.manage.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
org_id (query) | Uuid | לא | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404… |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
amount_minor | integer | כן | Minor units. The ceiling is a fat-finger guard, not a business rule — your provider's own gateway applies the real limits. |
currency | string | כן | — |
idempotency_key | string | לא | Your own replay key. Optional; when absent the server mints one, so a double-submit is at worst a second deliberate-looking top-up rather than a silent double charge. |
gateway | string | לא | Which rail to take the money on — stripe, paypal or nowpayments. ⛔ Only meaningful when you buy directly from Zinn®: a reseller's client is always charged on their… |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
quoted_minor | integer | לא | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | לא | What actually arrived. null = not known yet, never zero. |
fee_minor | integer | null | לא | What the provider kept out of the settlement. null = not known, never zero — recording an unknown as 0 would credit the customer the shortfall. |
credited_minor | integer | לא | What went into the balance — settled_minor - fee_minor. |
shortfall_minor | integer | null | לא | quoted_minor - credited_minor. null until the top-up settles. Derived rather than stored: it is a difference between two recorded facts, and a stored copy is a second source… |
purpose | string<general, ai> | לא | — |
is_auto | boolean | לא | Whether a standing instruction created this, rather than a person. |
action_url | string | לא | Where the customer must go to finish paying — a crypto pay-link or an SCA challenge. Losing it strands a pending top-up with no way to complete it. |
id | Uuid | כן | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | כן | — |
currency | string | כן | — |
status | string<pending, requires_action, captured, failed> | כן | ⛔ Credit is written on captured only. pending (a crypto invoice confirming) and requires_action (3-D Secure) both mean the money has not arrived yet. |
refunded_minor | integer | כן | — |
refundable_minor | integer | כן | What is left to send back to the card. Zero unless it captured. |
gateway | string | לא | The provider's driver — stripe, paypal, nowpayments. ⛔ Never a credential and never a merchant-account reference: which account your provider banks with is their commercial… |
error | string | לא | The gateway's refusal, in words the customer can act on. |
created_at | string | כן | — |
captured_at | string | null | לא | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429