reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس billing.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
جہاں آپ کی تنظیم کی آئی ڈی آتی ہے
یہ اینڈ پوائنٹ org_id کو بطور کوئری پیرامیٹر لیتا ہے۔ اسے چھوڑ دیں اور کال آپ کے پورے ٹیننسی سب ٹری کا احاطہ کرے گی؛ کال کو کسی ایک آرگنائزیشن تک محدود کرنے کے لیے اسے بھیجیں۔
آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں
تفصیلات
⭐ Answers 200 with defaults for an account that has never saved any, rather than 404: a settings screen that 404s before first save forces the client to treat "absent" and "off" as two states and then render them identically anyway. low_balance_threshold_minor of 0 means the warning is off, not "warn me at zero" — a customer who never chose a threshold holds 0, and treating that as a threshold would warn every account with an empty wallet. Requires billing.view.
پیرامیٹرز
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
currency (query) | string | نہیں | ISO-4217 code. Settings are per-currency because balances are: an account quoted in EUR and USD holds two balances that are never mixed, so one threshold would be a threshold… |
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… |
جواب
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
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… |
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