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