reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na billing.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Kung saan mapupunta ang id ng iyong organisasyon
Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
⭐ 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`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
currency (query) | string | Hindi | 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 | Hindi | 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… |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
org_id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Oo | — |
low_balance_threshold_minor | integer | Oo | 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 | Oo | — |
auto_topup_trigger_minor | integer | Hindi | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Hindi | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Hindi | Which saved method to charge. `null` uses the account's default. |
auto_topup_disarmed | boolean | Hindi | ⭐ **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 | Hindi | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 422 · 429