确认奖励商品领取
POST/api/v1/rewards/product/claim
客户审阅奖励商品及后续续费金额后明确接受,按原兑换记录和请求 ID 准备结账;持有仅由验证付款授予。
SDK 0.0.1更新于
发起请求
客户审阅奖励商品及后续续费金额后明确接受,按原兑换记录和请求 ID 准备结账;持有仅由验证付款授予。
- 调用凭据
- 仅客户 Token。身份由 Token 绑定。
- 所需权限
offers:resolve
base URL 和 App ID 来自 SDK 接入页。示例使用占位值,不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/rewards/product/claim" \2 -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4 -H "X-Groove-Environment: sandbox" \5 -H "Content-Type: application/json" \6 -d '{7 "redemptionId": "00000000-0000-4000-8000-000000000001",8 "currency": "USD",9 "requestId": "00000000-0000-4000-8000-000000000001",10 "accepted": true11}'
响应选项卡列出字段类型,不是响应示例;实际值由客户状态决定。
请求参数
JSON 请求体
redemptionIduuid必填本次操作的 redemptionId 值,类型和约束见字段标注。
currencyenum必填已发布价格支持的币种代码。
查看允许值
"USD""EUR""CNY""GBP""JPY""CAD""AUD""NZD""CHF""HKD""SGD""KRW""INR""BRL""MXN""TWD""THB""IDR""MYR""PHP""VND""ZAR""AED""SAR""SEK""NOK""DKK""PLN""CZK""HUF""ILS""TRY""RON"
requestIduuid必填你的业务请求 UUID;同一次操作重试复用,新的操作生成新值。
acceptedtrue必填操作是否被业务规则接受。HTTP 200 不等于 accepted 为 true。
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果;可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID,排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对,不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围:sandbox 或 live。
查看允许值
"sandbox""live"
checkoutobject | object必填本次操作的 checkout 值,类型和约束见字段标注。
展开子字段
type"checkout" | "subscription"必填本次操作的 type 值,类型和约束见字段标注。
orderIduuid可选本次操作的 orderId 值,类型和约束见字段标注。
productVersionIduuid | uuid必填本次操作的 productVersionId 值,类型和约束见字段标注。
currencyenum | enum必填已发布价格支持的币种代码。
durationobject | object | object | object | object | object必填本次操作的 duration 值,类型和约束见字段标注。
展开子字段
type"once" | "repeating" | "forever" | "once" | "repeating" | "forever"必填本次操作的 type 值,类型和约束见字段标注。
monthsinteger | integer可选本次操作的 months 值,类型和约束见字段标注。
renewalAmountMinorinteger | integer必填本次操作的 renewalAmountMinor 值,类型和约束见字段标注。
statusenum | enum必填本次操作的 status 值,类型和约束见字段标注。
urluri | null可选托管结账地址;支付结果由已验证的 provider 通知确认。
operationIduuid可选业务操作 UUID;订阅执行引用 previewAttach 返回的 operationId,余额退款引用原消费操作。
membershipIduuid可选本次操作的 membershipId 值,类型和约束见字段标注。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key,或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key,或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引