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, за да можете да видите действителния отговор. Отворете този крайpoint в 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… |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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 commercial… |
error | string | Не | The gateway's refusal, in words the customer can act on. |
created_at | string | Да | — |
captured_at | string | null | Не | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429