Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the 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
| Name | Type | Required | What it is |
|---|---|---|---|
currency (query) | string | No | 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 | No | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Yes | — |
low_balance_threshold_minor | integer | Yes | 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 | Yes | — |
auto_topup_trigger_minor | integer | No | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | No | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | No | Which saved method to charge. `null` uses the account's default. |
auto_topup_disarmed | boolean | No | ⭐ **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 | No | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | No | — |
Errors this endpoint can return
401 · 403 · 422 · 429