reseller

PUT `/v1/wallet/settings`

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

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن billing.payment.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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

PUT /v1/wallet/settings