reseller
POST /v1/reseller/client-wallets/{walletId}/adjustments
Correct a client's balance.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.manage; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
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> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
walletId (path) | Uuid | Sim | — |
org_id (query) | Uuid | Não | 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… |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
amount_minor | integer | Sim | Signed minor units. ⛔ Cannot take the client below zero. |
reason | string | Sim | Required, and the client sees it on their statement. An unexplained movement of somebody else's money is the first thing an audit asks about. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | Sim | — |
balance_minor | integer | Sim | What you are **owed** — the float your provider is holding for you. |
spendable_minor | integer | Sim | What 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_id | Uuid | null | Não | The provider whose float this is. |
entries | ClientWalletEntry[] | Sim | — |
other_floats | ClientOtherFloat[] | Sim | Balances 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… |
provider | string<reseller, zinn> | Não | ⭐ **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.… |
purses | WalletPurse[] | Não | The 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… |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429