reseller
GET /v1/wallet/top-ups/estimate
What a top-up will actually credit, before you pay.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن 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
التفاصيل
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