commerce

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

Approve a pending refund request (staff).

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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