reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
تصدیقهویت
یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.
چیرته چې ستاسو د سازمان آی ډي ځي
دا پای ټکی د پوښتنې پیرامیتر په توګه org_id اخلي. دا پریږدئ او زنګ ستاسو د استوګنې ټولې څانګې پوښي؛ د یوې سازمان لپاره د زنګ محدودولو لپاره یې واستوئ.
ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.
هڅه وکړئ
د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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