Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.payment.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
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> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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`.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id (query) | Uuid | Nie | 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… |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
amount_minor | integer | Tak | Minor units. The ceiling is a fat-finger guard, not a business rule — your provider's own gateway applies the real limits. |
currency | string | Tak | — |
idempotency_key | string | Nie | 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 | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
quoted_minor | integer | Nie | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | Nie | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | Nie | 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 | Nie | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | Nie | `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> | Nie | — |
is_auto | boolean | Nie | Whether a standing instruction created this, rather than a person. |
action_url | string | Nie | 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 | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Tak | — |
currency | string | Tak | — |
status | string<pending, requires_action, captured, failed> | Tak | ⛔ 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 | Tak | — |
refundable_minor | integer | Tak | What is left to send back to the card. Zero unless it captured. |
gateway | string | Nie | 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 | Nie | The gateway's refusal, in words the customer can act on. |
created_at | string | Tak | — |
captured_at | string | null | Nie | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429