commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Approves a pending (pro-rata / goodwill) refund request and issues the refund. Staff-only — requires the `billing.refund` permission held by a staff role, not by any customer role.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
refundRequestId (path) | Uuid | Так | The refund request's id. |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
note | string | Ні | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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