reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar billing.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
⭐ 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`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
currency (query) | string | Hayır | 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 | Hayır | 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… |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
org_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Evet | — |
low_balance_threshold_minor | integer | Evet | 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 | Evet | — |
auto_topup_trigger_minor | integer | Hayır | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Hayır | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Hayır | Which saved method to charge. `null` uses the account's default. |
auto_topup_disarmed | boolean | Hayır | ⭐ **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 | Hayır | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Hayır | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 422 · 429