reseller
PUT /v1/wallet/settings
Set your low-balance warning and automatic top-up.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл billing.payment.manage; ключ без нього відхиляється з кодом 403, а не 404.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X PUT https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
⚖️ Both settings are the customer's to choose — "notificaitons when low they can set" and "can they set the wallet to auto topup before payments are due so they can be taken from the waller (fallback to card/paypal or whateer they have setup)" (owner, 2026-08-22). The fallback in that sentence is already how checkout works: credit is spent first and the remainder goes to the card, so an automatic top-up that has not fired yet never blocks a payment. Switching automatic top-up on without an amount is a 422. ⭐ Saving clears the disarm counter. A standing instruction switches itself off after three consecutive failures, and a customer arriving at this screen after being told so has just fixed something — leaving them disarmed would mean their fix silently did nothing. Requires billing.payment.manage.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
currency (query) | string | Ні | ISO-4217 code these settings apply to. |
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… |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
low_balance_threshold_minor | integer | Ні | — |
auto_topup_enabled | boolean | Ні | — |
auto_topup_trigger_minor | integer | Ні | — |
auto_topup_amount_minor | integer | Ні | — |
auto_topup_payment_method_id | Uuid | null | Ні | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Так | — |
low_balance_threshold_minor | integer | Так | Warn when spendable credit falls below this. 0 means off, not "warn me at zero": a customer who never chose one holds 0, and reading that as a threshold would warn every… |
auto_topup_enabled | boolean | Так | — |
auto_topup_trigger_minor | integer | Ні | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Ні | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Ні | Which saved method to charge. null uses the account's default. |
auto_topup_disarmed | boolean | Ні | ⭐ The state a customer most needs to see and can least infer. A standing instruction switches itself off after three consecutive failures, and auto_topup_enabled stays… |
auto_topup_last_failure | string | Ні | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Ні | — |
Помилки, які може повертати ця кінцева точка
401 · 403 · 422 · 429