reseller

GET /v1/wallet/settings

Your low-balance warning and automatic top-up.

Све reseller крајње тачке

Сва документација за програмере →

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу billing.view; кључ без ње се одбија уз 403, а не 404.

Где се уноси ID ваше организације

Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

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

Параметри

НазивТипОбавезноШта је ово
currency (query)stringНе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…
org_id (query)UuidНе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…

Одговор

НазивТипОбавезноШта је ово
org_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
currencystringДа—
low_balance_threshold_minorintegerДа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_enabledbooleanДа—
auto_topup_trigger_minorintegerНеBuy more credit when the balance falls below this.
auto_topup_amount_minorintegerНеHow much to add when the rule fires.
auto_topup_payment_method_idUuid | nullНеWhich saved method to charge. null uses the account's default.
auto_topup_disarmedbooleanНе⭐ 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…
auto_topup_last_failurestringНеWhy the last attempt failed, in words safe to show the customer.
auto_topup_last_run_atstring | nullНе—

Грешке које ова крајња тачка може вратити

401 · 403 · 422 · 429