commerce

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

Get a refund request.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز billing.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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

پارامترها

نام	نوع	الزامی	چیست
`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}