commerce

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

Get a refund request.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن billing.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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}