reseller

GET `/v1/wallet/settings`

Your low-balance warning and automatic top-up.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`currency (query)`	`string`	Ne	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`	Ne	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…

Odpověď

Název	Typ	Požadováno	Co to je
`org_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`currency`	`string`	Ano	—
`low_balance_threshold_minor`	`integer`	Ano	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`	Ano	—
`auto_topup_trigger_minor`	`integer`	Ne	Buy more credit when the balance falls below this.
`auto_topup_amount_minor`	`integer`	Ne	How much to add when the rule fires.
`auto_topup_payment_method_id`	`Uuid \| null`	Ne	Which saved method to charge. `null` uses the account's default.
`auto_topup_disarmed`	`boolean`	Ne	⭐ 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`	Ne	Why the last attempt failed, in words safe to show the customer.
`auto_topup_last_run_at`	`string \| null`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 422 · 429