reseller
GET /v1/wallet
Your credit balance with your provider.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл billing.view; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/wallet \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
currency (query) | string | Ні | 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 | Ні | 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… |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Так | — |
balance_minor | integer | Так | What you are owed — the float your provider is holding for you. |
spendable_minor | integer | Так | 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 against… |
reseller_org_id | Uuid | null | Ні | The provider whose float this is. |
entries | ClientWalletEntry[] | Так | — |
other_floats | ClientOtherFloat[] | Так | 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… |
provider | string<reseller, zinn> | Ні | ⭐ 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[] | Ні | 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 store… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429