reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה reseller.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
המקום שבו מזהה הארגון שלך נכנס
נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.
מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X POST https://api.zinndigital.com/v1/reseller/client-wallets/top-ups/{topUpId}/refunds \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
⛔ **Back the way it came.** There is deliberately no "refund to wallet" option: a top-up already *is* wallet credit, so crediting it again would be a no-op wearing the name of a remedy, and wallet credit is an opt-in under consumer law rather than something silence can agree to. The balance is debited first and the gateway refund taken second; if the client has already spent the deposit the refund is refused with 422, and if the gateway declines it the balance is put back. Requires `reseller.manage`.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
topUpId (path) | Uuid | כן | — |
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… |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
amount_minor | integer | לא | Omit to refund everything still refundable on the deposit. |
reason | string | לא | — |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
quoted_minor | integer | לא | What the customer asked to add, and what the screen promised them. |
settled_minor | integer | null | לא | What actually arrived. **`null` = not known yet**, never zero. |
fee_minor | integer | null | לא | What the provider kept out of the settlement. **`null` = not known**, never zero — recording an unknown as `0` would credit the customer the shortfall. |
credited_minor | integer | לא | What went into the balance — `settled_minor - fee_minor`. |
shortfall_minor | integer | null | לא | `quoted_minor - credited_minor`. `null` until the top-up settles. Derived rather than stored: it is a difference between two recorded facts, and a stored copy is a second source… |
purpose | string<general, ai> | לא | — |
is_auto | boolean | לא | Whether a standing instruction created this, rather than a person. |
action_url | string | לא | Where the customer must go to finish paying — a crypto pay-link or an SCA challenge. Losing it strands a pending top-up with no way to complete it. |
id | Uuid | כן | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
amount_minor | integer | כן | — |
currency | string | כן | — |
status | string<pending, requires_action, captured, failed> | כן | ⛔ Credit is written on `captured` only. `pending` (a crypto invoice confirming) and `requires_action` (3-D Secure) both mean the money has not arrived yet. |
refunded_minor | integer | כן | — |
refundable_minor | integer | כן | What is left to send back to the card. Zero unless it captured. |
gateway | string | לא | The provider's driver — `stripe`, `paypal`, `nowpayments`. ⛔ Never a credential and never a merchant-account reference: which account your provider banks with is their commercia… |
error | string | לא | The gateway's refusal, in words the customer can act on. |
created_at | string | כן | — |
captured_at | string | null | לא | — |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 404 · 422 · 429