commerce

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

Get a refund request.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د billing.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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`	هو	—

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 429

GET /v1/refund-requests/{refundRequestId}