读取套餐余额来源
POST/api/v1/balances/source/read
读取指定余额来源和补赠的可用、预扣及已消费总额，以及授予量、到期、下次重置和编辑修订号。
SDK 0.0.1更新于
发起请求
读取指定余额来源和补赠的可用、预扣及已消费总额，以及授予量、到期、下次重置和编辑修订号。
- 调用凭据
- 仅服务端 API Key。由可信后端调用。
- 所需权限
credits:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/balances/source/read" \2 -H "Authorization: Bearer $GROOVE_SECRET_KEY" \3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4 -H "X-Groove-Environment: sandbox" \5 -H "Content-Type: application/json" \6 -d '{7 "customerId": "00000000-0000-4000-8000-000000000001",8 "sourceId": "00000000-0000-4000-8000-000000000001"9}'
响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。
请求参数
JSON 请求体
customerIduuid必填Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
sourceIduuid必填本次操作的 sourceId 值，类型和约束见字段标注。
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
balanceobject必填本次操作的 balance 值，类型和约束见字段标注。
展开子字段
sourceIduuid必填本次操作的 sourceId 值，类型和约束见字段标注。
availablestring必填本次操作的 available 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,12})?$
heldstring必填本次操作的 held 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,12})?$
spentstring必填本次操作的 spent 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,12})?$
adjustmentGrantIduuid | null必填本次操作的 adjustmentGrantId 值，类型和约束见字段标注。
grantedstring必填本次操作的 granted 值，类型和约束见字段标注。
pattern: ^(0|[1-9]\d{0,17})(\.\d{1,12})?$
expiresAtdate-time | null必填ISO 8601 UTC 到期时间；会话和预占到期后不能继续使用。
nextResetAtdate-time | null必填本次操作的 nextResetAt 值，类型和约束见字段标注。
revisioninteger必填读取资料时返回的版本号；更新使用它检测并发修改。
min: 0 · max: 9007199254740991
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引