reseller

GET /v1/wallet/top-ups/estimate

What a top-up will actually credit, before you pay.

Tutti gli endpoint reseller

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione billing.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

L'ID della tua organizzazione va qui

Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/wallet/top-ups/estimate?amount_minor=<amount_minor> \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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

Parametri

NomeTipoObbligatorioChe cos'è
amount_minor (query)integerThe amount you want to add, in integer minor units.
currency (query)stringNoISO-4217 code. A wallet is per-currency; an unknown code is a 422.
gateway (query)stringNoWhich 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)UuidNoWhich 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…

Risposta

NomeTipoObbligatorioChe cos'è
currencystring
gatewaystring
quoted_minorintegerWhat the customer asked to add.
expected_credit_minorintegerWhat we expect to put in their balance.
is_estimateboolean⛔ **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…
refundableboolean⚖️ 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…
expiresboolean⚖️ 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"*.

Errori che questo endpoint può restituire

401 · 403 · 422 · 429