reseller
GET /v1/wallet/top-ups/estimate
What a top-up will actually credit, before you pay.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/wallet/top-ups/estimate?amount_minor=<amount_minor> \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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… |
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… |
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