准备自动付款授权
POST/api/v1/billing/authorizations/prepare
固定商品、权益和金额限制，准备 Sandbox 支付方式；准备成功尚未启用付款。
SDK 0.0.1更新于
发起请求
固定商品、权益和金额限制，准备 Sandbox 支付方式；准备成功尚未启用付款。
- 调用凭据
- 仅客户 Token。身份由 Token 绑定。
- 所需权限
billing:write
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
Web Beta 的结账需要明确配置 Stripe Sandbox 测试账号与已发布价格映射。跳转完成不等于支付确认。
1curl -X POST "$GROOVE_BASE_URL/api/v1/billing/authorizations/prepare" \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 "requestId": "00000000-0000-4000-8000-000000000001",8 "productVersionId": "00000000-0000-4000-8000-000000000001",9 "entitlementVersionId": "00000000-0000-4000-8000-000000000001",10 "kind": "auto_topup",11 "currency": "USD",12 "maxAmountMinorPerPeriod": "10000",13 "threshold": "100",14 "maxPurchasesPerDay": 115}'
响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。
请求参数
JSON 请求体
requestIduuid | uuid必填你的业务请求 UUID；同一次操作重试复用，新的操作生成新值。
productVersionIduuid | uuid必填本次操作的 productVersionId 值，类型和约束见字段标注。
entitlementVersionIduuid | uuid必填本次操作的 entitlementVersionId 值，类型和约束见字段标注。
currencyenum | enum必填已发布价格支持的币种代码。
maxAmountMinorPerPeriodstring | string必填本次操作的 maxAmountMinorPerPeriod 值，类型和约束见字段标注。
kind"auto_topup" | "postpaid"必填本次操作的 kind 值，类型和约束见字段标注。
thresholdstring可选本次操作的 threshold 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,11})(\.\d{1,6})?$
maxPurchasesPerDayinteger可选本次操作的 maxPurchasesPerDay 值，类型和约束见字段标注。
min: 1 · max: 1000
purchaseLimitsobject可选本次操作的 purchaseLimits 值，类型和约束见字段标注。
展开子字段
hourinteger可选本次操作的 hour 值，类型和约束见字段标注。
min: 1 · max: 1000
weekinteger可选本次操作的 week 值，类型和约束见字段标注。
min: 1 · max: 1000
monthinteger可选本次操作的 month 值，类型和约束见字段标注。
min: 1 · max: 1000
maxOutstandingMinorstring可选本次操作的 maxOutstandingMinor 值，类型和约束见字段标注。
pattern: ^(?:[1-9]\d{0,7}|1\d{8}|200000000)$
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
preparedobject必填本次操作的 prepared 值，类型和约束见字段标注。
展开子字段
authorizationIduuid必填本次操作的 authorizationId 值，类型和约束见字段标注。
termsobject | object必填本次操作的 terms 值，类型和约束见字段标注。
展开子字段
productVersionIduuid | uuid必填本次操作的 productVersionId 值，类型和约束见字段标注。
entitlementVersionIduuid | uuid必填本次操作的 entitlementVersionId 值，类型和约束见字段标注。
currencyenum | enum必填已发布价格支持的币种代码。
maxAmountMinorPerPeriodstring | string必填本次操作的 maxAmountMinorPerPeriod 值，类型和约束见字段标注。
kind"auto_topup" | "postpaid"必填本次操作的 kind 值，类型和约束见字段标注。
thresholdobject可选本次操作的 threshold 值，类型和约束见字段标注。
maxPurchasesPerDayinteger可选本次操作的 maxPurchasesPerDay 值，类型和约束见字段标注。
min: 1 · max: 1000
purchaseLimitsobject可选本次操作的 purchaseLimits 值，类型和约束见字段标注。
展开子字段
hourinteger可选本次操作的 hour 值，类型和约束见字段标注。
min: 1 · max: 1000
weekinteger可选本次操作的 week 值，类型和约束见字段标注。
min: 1 · max: 1000
monthinteger可选本次操作的 month 值，类型和约束见字段标注。
min: 1 · max: 1000
purchaseAmountMinorstring可选本次操作的 purchaseAmountMinor 值，类型和约束见字段标注。
pattern: ^(?:[1-9]\d{0,7}|1\d{8}|200000000)$
purchaseUnitsobject可选本次操作的 purchaseUnits 值，类型和约束见字段标注。
maxOutstandingMinorstring可选本次操作的 maxOutstandingMinor 值，类型和约束见字段标注。
pattern: ^(?:[1-9]\d{0,7}|1\d{8}|200000000)$
cashPriceobject可选本次操作的 cashPrice 值，类型和约束见字段标注。
展开子字段
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"
pricingobject | object必填本次操作的 pricing 值，类型和约束见字段标注。
billingCycleobject可选本次操作的 billingCycle 值，类型和约束见字段标注。
setupUrluri | null必填本次操作的 setupUrl 值，类型和约束见字段标注。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引