reseller
POST /v1/reseller/client-wallets/top-ups/{topUpId}/refunds
Send a deposit back to the card it came from.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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