reseller
GET /v1/wallet/top-ups/estimate
What a top-up will actually credit, before you pay.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/wallet/top-ups/estimate?amount_minor=<amount_minor> \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
amount_minor (query) | integer | 是 | The amount you want to add, in integer minor units. |
currency (query) | string | 否 | ISO-4217 code. A wallet is per-currency; an unknown code is a 422. |
gateway (query) | string | 否 | 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 | 否 | 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… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
currency | string | 是 | — |
gateway | string | 是 | — |
quoted_minor | integer | 是 | What the customer asked to add. |
expected_credit_minor | integer | 是 | What we expect to put in their balance. |
is_estimate | boolean | 是 | ⛔ **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 | 是 | ⚖️ 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 | 是 | ⚖️ 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"*. |
此端点可能返回的错误
401 · 403 · 422 · 429