commerce

POST `/v1/refund-requests/{refundRequestId}/approve`

Approve a pending refund request (staff).

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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.

פרמטרים

שם	סוג	נדרש	מה זה
`refundRequestId (path)`	`Uuid`	כן	The refund request's id.

גוף הבקשה

שם	סוג	נדרש	מה זה
`note`	`string`	לא	—

תשובה

שם	סוג	נדרש	מה זה
`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 · 409 · 422 · 429

POST /v1/refund-requests/{refundRequestId}/approve