reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
⭐ 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`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
currency (query) | string | Nee | 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 | Nee | 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… |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
org_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Ja | — |
low_balance_threshold_minor | integer | Ja | 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 | Ja | — |
auto_topup_trigger_minor | integer | Nee | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Nee | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Nee | Which saved method to charge. `null` uses the account's default. |
auto_topup_disarmed | boolean | Nee | ⭐ **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 | Nee | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Nee | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 422 · 429