commerce

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

Get a refund request.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya billing.view; ufunguo usio nayo unakataliwa kwa 403, si 404.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`refundRequestId (path)`	`Uuid`	Ndiyo	The refund request's id.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`order_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`RefundRequestStatus`	Ndiyo	A refund request's lifecycle state (docs/05 §4.13).
`policy_class`	`RefundPolicyClass`	Ndiyo	How the refund policy classified a request (captured at request time).
`amount`	`MoneyAmount`	Ndiyo	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`to_wallet`	`boolean`	Ndiyo	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`	Ndiyo	—
`decided_by`	`string`	Ndiyo	—
`decision_note`	`string`	Ndiyo	—
`decided_at`	`object`	Ndiyo	—
`refund_reference`	`string`	Ndiyo	Set once the refund has been issued (its idempotency key).
`created_at`	`string`	Ndiyo	—
`updated_at`	`string`	Ndiyo	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 429

GET /v1/refund-requests/{refundRequestId}