Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na billing.payment.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Kung saan mapupunta ang id ng iyong organisasyon
Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
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> }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
org_id (query) | Uuid | Hindi | 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… |
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
amount_minor | integer | Oo | Minor units. The ceiling is a fat-finger guard, not a business rule — your provider's own gateway applies the real limits. |
currency | string | Oo | — |
idempotency_key | string | Hindi | 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 | Hindi | 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… |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
quoted_minor | integer | Hindi | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | Hindi | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | Hindi | 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 | Hindi | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | Hindi | `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> | Hindi | — |
is_auto | boolean | Hindi | Whether a standing instruction created this, rather than a person. |
action_url | string | Hindi | 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 | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | Oo | — |
currency | string | Oo | — |
status | string<pending, requires_action, captured, failed> | Oo | ⛔ 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 | Oo | — |
refundable_minor | integer | Oo | What is left to send back to the card. Zero unless it captured. |
gateway | string | Hindi | 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 | Hindi | The gateway's refusal, in words the customer can act on. |
created_at | string | Oo | — |
captured_at | string | null | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 422 · 429