commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение billing.payment.manage; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве поля в теле JSON.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Opens a refund request per the policy: within the 30-day money-back window the refund is issued immediately (status `auto_approved`); otherwise a pro-rata request is recorded `pending` for staff approval (docs/05 §4.13). The amount and approval path come from the server, never the client. Requires `billing.payment.manage`.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
orderId (path) | Uuid | Да | The order's id. |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id | Uuid | Нет | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Нет | — |
to_wallet | boolean | Нет | Where the refund goes. Omit it and the money is returned to the original payment method — the money-back guarantee is money back, and store credit is an opt-in the customer has… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Да | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Да | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Да | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Да | Refund destination, frozen at request time — `false` (the default) reverses the original payment, `true` credits the account wallet. Any part of the order that was settled from… |
reason | string | Да | — |
decided_by | string | Да | — |
decision_note | string | Да | — |
decided_at | object | Да | — |
refund_reference | string | Да | Set once the refund has been issued (its idempotency key). |
created_at | string | Да | — |
updated_at | string | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 409 · 422 · 429