reseller

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

Correct a client's balance.

Všechny koncové body reseller

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění reseller.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

NázevTypPožadovánoCo to je
walletId (path)UuidAno
org_id (query)UuidNeWhich 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…

Tělo požadavku

NázevTypPožadovánoCo to je
amount_minorintegerAnoSigned minor units. ⛔ Cannot take the client below zero.
reasonstringAnoRequired, and the client sees it on their statement. An unexplained movement of somebody else's money is the first thing an audit asks about.

Odpověď

NázevTypPožadovánoCo to je
org_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
currencystringAno
balance_minorintegerAnoWhat you are **owed** — the float your provider is holding for you.
spendable_minorintegerAnoWhat 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 | nullNeThe provider whose float this is.
entriesClientWalletEntry[]Ano
other_floatsClientOtherFloat[]AnoBalances 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>Ne⭐ **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[]NeThe 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…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429