reseller

GET `/v1/wallet/settings`

Your low-balance warning and automatic top-up.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya billing.view; ufunguo usio nayo unakataliwa kwa 403, si 404.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Kigezo hiki kinachukua org_id kama kigezo cha utafutaji. Iache wazi na simu itashughulikia tawi lako lote la wapangaji; itume ili kupunguza simu iwe ya shirika moja tu.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`currency (query)`	`string`	Hapana	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`	Hapana	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…

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`org_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`currency`	`string`	Ndiyo	—
`low_balance_threshold_minor`	`integer`	Ndiyo	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`	Ndiyo	—
`auto_topup_trigger_minor`	`integer`	Hapana	Buy more credit when the balance falls below this.
`auto_topup_amount_minor`	`integer`	Hapana	How much to add when the rule fires.
`auto_topup_payment_method_id`	`Uuid \| null`	Hapana	Which saved method to charge. `null` uses the account's default.
`auto_topup_disarmed`	`boolean`	Hapana	⭐ 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`	Hapana	Why the last attempt failed, in words safe to show the customer.
`auto_topup_last_run_at`	`string \| null`	Hapana	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 422 · 429