reseller
GET /v1/wallet/top-ups/estimate
What a top-up will actually credit, before you pay.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění billing.view; 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 GET https://api.zinndigital.com/v1/wallet/top-ups/estimate?amount_minor=<amount_minor> \
-H "Authorization: Bearer zdk_live_…"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
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
amount_minor (query) | integer | Ano | The amount you want to add, in integer minor units. |
currency (query) | string | Ne | ISO-4217 code. A wallet is per-currency; an unknown code is a 422. |
gateway (query) | string | Ne | 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 | Ne | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
currency | string | Ano | — |
gateway | string | Ano | — |
quoted_minor | integer | Ano | What the customer asked to add. |
expected_credit_minor | integer | Ano | What we expect to put in their balance. |
is_estimate | boolean | Ano | ⛔ 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… |
refundable | boolean | Ano | ⚖️ 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… |
expires | boolean | Ano | ⚖️ 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". |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422 · 429