commerce

GET /v1/refund-requests/{refundRequestId}

Get a refund request.

所有 commerce 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 billing.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

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

免费试用

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

curl -X GET https://api.zinndigital.com/v1/refund-requests/{refundRequestId} \
  -H "Authorization: Bearer zdk_live_…"

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Returns one refund request in scope, with its policy class, amount and outcome. Requires `billing.view`.

参数

名称类型必填内容简介
refundRequestId (path)UuidThe refund request's id.

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
order_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusRefundRequestStatusA refund request's lifecycle state (docs/05 §4.13).
policy_classRefundPolicyClassHow the refund policy classified a request (captured at request time).
amountMoneyAmountA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
to_walletbooleanRefund 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…
reasonstring
decided_bystring
decision_notestring
decided_atobject
refund_referencestringSet once the refund has been issued (its idempotency key).
created_atstring
updated_atstring

此端点可能返回的错误

401 · 403 · 404 · 429