commerce

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

Get a refund request.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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

Paraméterek

Név	Típus	Kötelező	Mi ez
`refundRequestId (path)`	`Uuid`	Igen	The refund request's id.

Válasz

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

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429

GET /v1/refund-requests/{refundRequestId}