reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit billing.view ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Tashkilotingiz identifikatori kiritiladigan joy
Bu soʻrovnoma oxiri org_id parametrini soʻrov parametri sifatida qabul qiladi. Uni kiritmasangiz, chaqiruv butun ijarachi quyi daraxtingizni qamrab oladi; uni bitta tashkilotga cheklash uchun yuboring.
Tashkilotingiz identifikatori boshqaruv panelingizdagi API kalitlari ekranida, kalitning o'z yonida joylashgan. Bu siz amalga oshiradigan har bir so'rovda bir xil identifikator hisoblanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
⭐ 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`.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
currency (query) | string | Yo'q | 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 ag… |
org_id (query) | Uuid | Yo'q | 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… |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
org_id | Uuid | Ha | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Ha | — |
low_balance_threshold_minor | integer | Ha | 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 | Ha | — |
auto_topup_trigger_minor | integer | Yo'q | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Yo'q | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Yo'q | Which saved method to charge. `null` uses the account's default. |
auto_topup_disarmed | boolean | Yo'q | ⭐ **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 | Yo'q | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Yo'q | — |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 422 · 429