reseller
PUT /v1/wallet/settings
Set your low-balance warning and automatic top-up.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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 r… |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 `tr… |
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