reseller
GET /v1/wallet/settings
Your low-balance warning and automatic top-up.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/wallet/settings \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
⭐ 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
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
currency (query) | string | Nie | 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 | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
org_id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Tak | — |
low_balance_threshold_minor | integer | Tak | 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 | Tak | — |
auto_topup_trigger_minor | integer | Nie | Buy more credit when the balance falls below this. |
auto_topup_amount_minor | integer | Nie | How much to add when the rule fires. |
auto_topup_payment_method_id | Uuid | null | Nie | Which saved method to charge. null uses the account's default. |
auto_topup_disarmed | boolean | Nie | ⭐ 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 | Nie | Why the last attempt failed, in words safe to show the customer. |
auto_topup_last_run_at | string | null | Nie | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 422 · 429