reseller
POST /v1/reseller/client-wallets/{walletId}/adjustments
Correct a client's balance.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл reseller.manage; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/reseller/client-wallets/{walletId}/adjustments \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "amount_minor": <integer>, "reason": <string> }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Signed — positive credits, negative takes back. ⛔ A negative adjustment that would put the client below zero is refused with 422 naming what is available: you may correct your own mistake, you may not push a customer into debt. `reason` is required and the client sees it on their statement. A wallet belonging to another reseller answers 404, never 403, so this is not an existence oracle. Requires `reseller.manage`.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
walletId (path) | Uuid | Так | — |
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… |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
amount_minor | integer | Так | Signed minor units. ⛔ Cannot take the client below zero. |
reason | string | Так | Required, and the client sees it on their statement. An unexplained movement of somebody else's money is the first thing an audit asks about. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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 again… |
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 disa… |
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 stor… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429