reseller

GET `/v1/wallet/settings`

Your low-balance warning and automatic top-up.

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin billing.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini menerima org_id sebagai parameter kueri. Kosongkan parameter tersebut dan panggilan ini akan mencakup seluruh subpohon penyewa Anda; kirimkan untuk mempersempit panggilan ke satu organisasi.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`currency (query)`	`string`	Tidak	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`	Tidak	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…

Tanggapan

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

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 422 · 429