身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X PUT https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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