reseller

GET /v1/wallet/top-ups/estimate

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

Wszystkie punkty końcowe reseller

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

NazwaTypWymaganeCo to jest
amount_minor (query)integerTakThe amount you want to add, in integer minor units.
currency (query)stringNieISO-4217 code. A wallet is per-currency; an unknown code is a 422.
gateway (query)stringNieWhich 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)UuidNieWhich 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…

Odpowiedź

NazwaTypWymaganeCo to jest
currencystringTak
gatewaystringTak
quoted_minorintegerTakWhat the customer asked to add.
expected_credit_minorintegerTakWhat we expect to put in their balance.
is_estimatebooleanTakNot 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…
refundablebooleanTak⚖️ 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…
expiresbooleanTak⚖️ 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".

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422 · 429