Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na billing.view; 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 GET https://api.zinndigital.com/v1/wallet \
-H "Authorization: Bearer zdk_live_…"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
The float your provider holds for you, and your statement of account. ⛔ This is **your provider's** money, not Zinn®'s: a top-up settles into their payment account and the balance is a debt they owe you. Two balances are returned and they can differ — `balance_minor` is what you are **owed**, `spendable_minor` is what you can spend today. They come apart when your provider's reseller programme is suspended: the deposit is still yours, but nothing is being delivered against it. ⭐ **Answers for both providers.** If your account is not managed by a reseller, this returns the credit you hold with **Zinn®** instead, and `provider` says which — a reseller float can be sent back to the card it came from, Zinn® credit never can. This used to be a 404, which the dashboard rendered as *"This account does not use credit"*; that was true only because there was no way to buy any. Requires `billing.view`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
currency (query) | string | Hindi | ISO-4217 code. A wallet is per-currency — a EUR float does not pay a USD invoice — so an unknown code is a 422 rather than a silent fallback. |
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… |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
org_id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Oo | — |
balance_minor | integer | Oo | What you are **owed** — the float your provider is holding for you. |
spendable_minor | integer | Oo | What you can **spend today**. Lower than `balance_minor` when your provider's reseller programme is suspended: the deposit is still yours, but nobody is delivering service again… |
reseller_org_id | Uuid | null | Hindi | The provider whose float this is. |
entries | ClientWalletEntry[] | Oo | — |
other_floats | ClientOtherFloat[] | Oo | Balances a **previous** provider still holds for you. ⛔ Normally empty. A client who changed provider is still owed what the old one took; omitting it would make that money disa… |
provider | string<reseller, zinn> | Hindi | ⭐ **Who is holding this money.** One screen serves both, because *"credit you hold with your provider"* is one question whose answer depends on the customer, not on the feature.… |
purses | WalletPurse[] | Hindi | The owner's *"one ledger, named purses"* — a balance may be restricted to a kind of spending. ⛔ Empty for a reseller float, which has no purses. A purse whose authoritative stor… |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 422 · 429