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 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