reseller

PUT `/v1/wallet/settings`

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

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation billing.payment.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

⚖️ 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ètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`currency (query)`	`string`	Non	ISO-4217 code these settings apply to.
`org_id (query)`	`Uuid`	Non	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…

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`low_balance_threshold_minor`	`integer`	Non	—
`auto_topup_enabled`	`boolean`	Non	—
`auto_topup_trigger_minor`	`integer`	Non	—
`auto_topup_amount_minor`	`integer`	Non	—
`auto_topup_payment_method_id`	`Uuid \| null`	Non	—

Réponse

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

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 422 · 429