reseller

GET `/v1/wallet/settings`

Your low-balance warning and automatic top-up.

Doğrulama

API açarını bearer token kimi göndərin. Açar billing.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`currency (query)`	`string`	Xeyr	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`	Xeyr	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…

Cavab

Ad	Tip	Tələb olunur	Nədir
`org_id`	`Uuid`	Bəli	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`currency`	`string`	Bəli	—
`low_balance_threshold_minor`	`integer`	Bəli	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`	Bəli	—
`auto_topup_trigger_minor`	`integer`	Xeyr	Buy more credit when the balance falls below this.
`auto_topup_amount_minor`	`integer`	Xeyr	How much to add when the rule fires.
`auto_topup_payment_method_id`	`Uuid \| null`	Xeyr	Which saved method to charge. `null` uses the account's default.
`auto_topup_disarmed`	`boolean`	Xeyr	⭐ 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`	Xeyr	Why the last attempt failed, in words safe to show the customer.
`auto_topup_last_run_at`	`string \| null`	Xeyr	—

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 422 · 429