reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.view; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Да | — |
low_balance_threshold_minor | integer | Да | 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 | Да | — |
auto_topup_trigger_minor | integer | Нет | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Нет | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Нет | Which saved method to charge. null uses the account's default. |
auto_topup_disarmed | boolean | Нет | ⭐ 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_failure | string | Нет | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Нет | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422 · 429