reseller
GET /v1/wallet/top-ups/estimate
What a top-up will actually credit, before you pay.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.view; 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 GET https://api.zinndigital.com/v1/wallet/top-ups/estimate?amount_minor=<amount_minor> \
-H "Authorization: Bearer zdk_live_…"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
The **pre-purchase disclosure**. Returns what we expect to put in your balance for a given amount and rail, and whether that figure can still move. ⚖️ Zinn® credits **what actually settles**, net of fees, at the real settlement rate (owner ruling 2026-08-22). On a card that is exactly the amount you asked for. On a crypto rail it can be less, because the value of the coin moves between the quote and the confirmation and the network takes a fee — so `is_estimate` is `true` and the figure is indicative. ⛔ A screen that renders `expected_credit_minor` without also reading `is_estimate` turns a disclosure into a promise. `refundable` and `expires` are both always `false` and are returned here, at the point of sale, because that is where a non-refundable purchase has to be disclosed. Requires `billing.view`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
amount_minor (query) | integer | Sim | The amount you want to add, in integer minor units. |
currency (query) | string | Não | ISO-4217 code. A wallet is per-currency; an unknown code is a 422. |
gateway (query) | string | Não | Which rail — `stripe`, `paypal` or `nowpayments`. Determines whether the estimate is exact or indicative; it is the crypto rail that settles at a moving rate. |
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… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
currency | string | Sim | — |
gateway | string | Sim | — |
quoted_minor | integer | Sim | What the customer asked to add. |
expected_credit_minor | integer | Sim | What we expect to put in their balance. |
is_estimate | boolean | Sim | ⛔ **Not decoration.** `true` on a rail that settles at a moving rate (crypto), where the amount credited can be less than the amount quoted because we credit what actually settl… |
refundable | boolean | Sim | ⚖️ Always `false` for Zinn® credit. *"credit is not returnable ever, even on account closure etc."* — owner, 2026-08-22. Returned at the point of sale because that is where a no… |
expires | boolean | Sim | ⚖️ Always `false`. Credit never expires — the deliberate other half of never refundable: *"you cannot have it back"* is only defensible alongside *"and you never lose it"*. |
Erros que este endpoint pode retornar
401 · 403 · 422 · 429