commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
Approves a pending (pro-rata / goodwill) refund request and issues the refund. Staff-only — requires the `billing.refund` permission held by a staff role, not by any customer role.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
refundRequestId (path) | Uuid | Có | The refund request's id. |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
note | string | Không | — |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Có | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Có | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Có | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Có | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Có | 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 | Có | — |
decided_by | string | Có | — |
decision_note | string | Có | — |
decided_at | object | Có | — |
refund_reference | string | Có | Set once the refund has been issued (its idempotency key). |
created_at | string | Có | — |
updated_at | string | Có | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 409 · 422 · 429