reseller

PUT `/v1/wallet/settings`

Set your low-balance warning and automatic top-up.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.payment.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X PUT https://api.zinndigital.com/v1/wallet/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

⚖️ 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`.

Paraméterek

Név	Típus	Kötelező	Mi ez
`currency (query)`	`string`	Nem	ISO-4217 code these settings apply to.
`org_id (query)`	`Uuid`	Nem	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…

Kérés törzse

Név	Típus	Kötelező	Mi ez
`low_balance_threshold_minor`	`integer`	Nem	—
`auto_topup_enabled`	`boolean`	Nem	—
`auto_topup_trigger_minor`	`integer`	Nem	—
`auto_topup_amount_minor`	`integer`	Nem	—
`auto_topup_payment_method_id`	`Uuid \| null`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`org_id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`currency`	`string`	Igen	—
`low_balance_threshold_minor`	`integer`	Igen	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`	Igen	—
`auto_topup_trigger_minor`	`integer`	Nem	Buy more credit when the balance falls below this.
`auto_topup_amount_minor`	`integer`	Nem	How much to add when the rule fires.
`auto_topup_payment_method_id`	`Uuid \| null`	Nem	Which saved method to charge. `null` uses the account's default.
`auto_topup_disarmed`	`boolean`	Nem	⭐ 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`	Nem	Why the last attempt failed, in words safe to show the customer.
`auto_topup_last_run_at`	`string \| null`	Nem	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422 · 429