reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea billing.view; o cheie care nu o are va fi respinsă cu 403, nu 404.
Unde merge ID-ul organizației tale
Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
⭐ 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`.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
currency (query) | string | Nu | 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 | Nu | 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… |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
org_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Da | — |
low_balance_threshold_minor | integer | Da | 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 | Da | — |
auto_topup_trigger_minor | integer | Nu | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Nu | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Nu | Which saved method to charge. `null` uses the account's default. |
auto_topup_disarmed | boolean | Nu | ⭐ **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 | Nu | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Nu | — |
Erori pe care le poate returna acest punct final
401 · 403 · 422 · 429