reseller

GET `/v1/wallet/top-ups/estimate`

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

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt akzeptiert org_id als Abfrageparameter. Lassen Sie ihn weg, erfasst der Aufruf Ihren gesamten Mandanten-Unterbaum; übergeben Sie ihn, um den Aufruf auf eine Organisation einzugrenzen.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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

Parameter

Name	Typ	Erforderlich	Was es ist
`amount_minor (query)`	`integer`	Ja	The amount you want to add, in integer minor units.
`currency (query)`	`string`	Nein	ISO-4217 code. A wallet is per-currency; an unknown code is a 422.
`gateway (query)`	`string`	Nein	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`	Nein	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…

Antwort

Name	Typ	Erforderlich	Was es ist
`currency`	`string`	Ja	—
`gateway`	`string`	Ja	—
`quoted_minor`	`integer`	Ja	What the customer asked to add.
`expected_credit_minor`	`integer`	Ja	What we expect to put in their balance.
`is_estimate`	`boolean`	Ja	⛔ 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`	Ja	⚖️ 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`	Ja	⚖️ 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".

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 422 · 429