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