commerce

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

Get a refund request.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте billing.view рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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`.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`refundRequestId (path)`	`Uuid`	Иә	The refund request's id.

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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 · 429

GET /v1/refund-requests/{refundRequestId}