commerce

GET `/v1/refund-requests/{refundRequestId}`

Get a refund request.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението billing.view; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Отговор

Име	Тип	Задължително	Какво представлява
`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`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429

GET /v1/refund-requests/{refundRequestId}