身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.payment.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点接受 org_id 作为 JSON 正文中的一个字段。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Opens a refund request per the policy: within the 30-day money-back window the refund is issued immediately (status `auto_approved`); otherwise a pro-rata request is recorded `pending` for staff approval (docs/05 §4.13). The amount and approval path come from the server, never the client. Requires `billing.payment.manage`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
orderId (path) | Uuid | 是 | The order's id. |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id | Uuid | 否 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | 否 | — |
to_wallet | boolean | 否 | Where the refund goes. Omit it and the money is returned to the original payment method — the money-back guarantee is money back, and store credit is an opt-in the customer has… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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