Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте billing.payment.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде 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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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 r… |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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 provide… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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 commercia… |
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