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