reseller

PUT `/v1/wallet/settings`

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.payment.manage verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

Name	Typ	Erforderlich	Was es ist
`currency (query)`	`string`	Nein	ISO-4217 code these settings apply to.
`org_id (query)`	`Uuid`	Nein	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…

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`low_balance_threshold_minor`	`integer`	Nein	—
`auto_topup_enabled`	`boolean`	Nein	—
`auto_topup_trigger_minor`	`integer`	Nein	—
`auto_topup_amount_minor`	`integer`	Nein	—
`auto_topup_payment_method_id`	`Uuid \| null`	Nein	—

Antwort

Name	Typ	Erforderlich	Was es ist
`org_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`currency`	`string`	Ja	—
`low_balance_threshold_minor`	`integer`	Ja	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`	Ja	—
`auto_topup_trigger_minor`	`integer`	Nein	Buy more credit when the balance falls below this.
`auto_topup_amount_minor`	`integer`	Nein	How much to add when the rule fires.
`auto_topup_payment_method_id`	`Uuid \| null`	Nein	Which saved method to charge. `null` uses the account's default.
`auto_topup_disarmed`	`boolean`	Nein	⭐ 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`	Nein	Why the last attempt failed, in words safe to show the customer.
`auto_topup_last_run_at`	`string \| null`	Nein	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 422 · 429