reseller

PUT /v1/wallet/settings

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

Všechny koncové body reseller

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.payment.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

NázevTypPožadovánoCo to je
currency (query)stringNeISO-4217 code these settings apply to.
org_id (query)UuidNeWhich 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…

Tělo požadavku

NázevTypPožadovánoCo to je
low_balance_threshold_minorintegerNe
auto_topup_enabledbooleanNe
auto_topup_trigger_minorintegerNe
auto_topup_amount_minorintegerNe
auto_topup_payment_method_idUuid | nullNe

Odpověď

NázevTypPožadovánoCo to je
org_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
currencystringAno
low_balance_threshold_minorintegerAnoWarn 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_enabledbooleanAno
auto_topup_trigger_minorintegerNeBuy more credit when the balance falls below this.
auto_topup_amount_minorintegerNeHow much to add when the rule fires.
auto_topup_payment_method_idUuid | nullNeWhich saved method to charge. `null` uses the account's default.
auto_topup_disarmedbooleanNe⭐ **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_failurestringNeWhy the last attempt failed, in words safe to show the customer.
auto_topup_last_run_atstring | nullNe

Chyby, které může tento koncový bod vrátit

401 · 403 · 422 · 429