commerce

GET /v1/refund-requests/{refundRequestId}

Get a refund request.

Усі кінцеві точки commerce

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл billing.view; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X GET https://api.zinndigital.com/v1/refund-requests/{refundRequestId} \
  -H "Authorization: Bearer zdk_live_…"

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Returns one refund request in scope, with its policy class, amount and outcome. Requires `billing.view`.

Параметри

НазваТипОбов'язковеЩо це таке
refundRequestId (path)UuidТакThe refund request's id.

Відповідь

НазваТипОбов'язковеЩо це таке
idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
order_idUuidТакUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusRefundRequestStatusТакA refund request's lifecycle state (docs/05 §4.13).
policy_classRefundPolicyClassТакHow the refund policy classified a request (captured at request time).
amountMoneyAmountТакA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
to_walletbooleanТак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…
reasonstringТак
decided_bystringТак
decision_notestringТак
decided_atobjectТак
refund_referencestringТакSet once the refund has been issued (its idempotency key).
created_atstringТак
updated_atstringТак

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429