reseller

GET /v1/wallet

Your credit balance with your provider.

Semua titik akhir reseller

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran billing.view; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

The float your provider holds for you, and your statement of account. ⛔ This is **your provider's** money, not Zinn®'s: a top-up settles into their payment account and the balance is a debt they owe you. Two balances are returned and they can differ — `balance_minor` is what you are **owed**, `spendable_minor` is what you can spend today. They come apart when your provider's reseller programme is suspended: the deposit is still yours, but nothing is being delivered against it. ⭐ **Answers for both providers.** If your account is not managed by a reseller, this returns the credit you hold with **Zinn®** instead, and `provider` says which — a reseller float can be sent back to the card it came from, Zinn® credit never can. This used to be a 404, which the dashboard rendered as *"This account does not use credit"*; that was true only because there was no way to buy any. Requires `billing.view`.

Parameter

NamaJenisDiperlukanApakah ia
currency (query)stringTidakISO-4217 code. A wallet is per-currency — a EUR float does not pay a USD invoice — so an unknown code is a 422 rather than a silent fallback.
org_id (query)UuidTidakWhich 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…

Respons

NamaJenisDiperlukanApakah ia
org_idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
currencystringYa
balance_minorintegerYaWhat you are **owed** — the float your provider is holding for you.
spendable_minorintegerYaWhat you can **spend today**. Lower than `balance_minor` when your provider's reseller programme is suspended: the deposit is still yours, but nobody is delivering service again…
reseller_org_idUuid | nullTidakThe provider whose float this is.
entriesClientWalletEntry[]Ya
other_floatsClientOtherFloat[]YaBalances a **previous** provider still holds for you. ⛔ Normally empty. A client who changed provider is still owed what the old one took; omitting it would make that money disa…
providerstring<reseller, zinn>Tidak⭐ **Who is holding this money.** One screen serves both, because *"credit you hold with your provider"* is one question whose answer depends on the customer, not on the feature.…
pursesWalletPurse[]TidakThe owner's *"one ledger, named purses"* — a balance may be restricted to a kind of spending. ⛔ Empty for a reseller float, which has no purses. A purse whose authoritative stor…

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429