reseller

GET `/v1/wallet/settings`

Your low-balance warning and automatic top-up.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X GET https://api.zinndigital.com/v1/wallet/settings \
  -H "Authorization: Bearer zdk_live_…"

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

⭐ 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`.

Paraméterek

Név	Típus	Kötelező	Mi ez
`currency (query)`	`string`	Nem	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`	Nem	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…

Válasz

Név	Típus	Kötelező	Mi ez
`org_id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`currency`	`string`	Igen	—
`low_balance_threshold_minor`	`integer`	Igen	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`	Igen	—
`auto_topup_trigger_minor`	`integer`	Nem	Buy more credit when the balance falls below this.
`auto_topup_amount_minor`	`integer`	Nem	How much to add when the rule fires.
`auto_topup_payment_method_id`	`Uuid \| null`	Nem	Which saved method to charge. `null` uses the account's default.
`auto_topup_disarmed`	`boolean`	Nem	⭐ 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`	Nem	Why the last attempt failed, in words safe to show the customer.
`auto_topup_last_run_at`	`string \| null`	Nem	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422 · 429