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