reseller

POST /v1/reseller/client-wallets/{walletId}/adjustments

Correct a client's balance.

Semua titik akhir reseller

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran reseller.manage; 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 POST https://api.zinndigital.com/v1/reseller/client-wallets/{walletId}/adjustments \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "amount_minor": <integer>, "reason": <string> }'

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

Signed — positive credits, negative takes back. ⛔ A negative adjustment that would put the client below zero is refused with 422 naming what is available: you may correct your own mistake, you may not push a customer into debt. `reason` is required and the client sees it on their statement. A wallet belonging to another reseller answers 404, never 403, so this is not an existence oracle. Requires `reseller.manage`.

Parameter

NamaJenisDiperlukanApakah ia
walletId (path)UuidYa
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…

Badan permintaan

NamaJenisDiperlukanApakah ia
amount_minorintegerYaSigned minor units. ⛔ Cannot take the client below zero.
reasonstringYaRequired, and the client sees it on their statement. An unexplained movement of somebody else's money is the first thing an audit asks about.

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