跳到正文
Indiana
控制台
文档
章节目录 / 设置银行卡

设置银行卡

POST/api/v1/billing/setup-payment

创建独立 Stripe Sandbox Setup Checkout。复用 requestId 恢复同一次设置;仅在 makeDefault 为 true 时设为默认卡。收集银行卡不创建订阅、不授予权益,也不代表同意用量扣款。浏览器使用已验证客户身份。

SDK 0.0.1更新于

发起请求

创建独立 Stripe Sandbox Setup Checkout。复用 requestId 恢复同一次设置;仅在 makeDefault 为 true 时设为默认卡。收集银行卡不创建订阅、不授予权益,也不代表同意用量扣款。浏览器使用已验证客户身份。

调用凭据
服务端 API Key 或客户 Token。客户调用不能选择其他客户。
所需权限
billing:write
base URL 和 App ID 来自 SDK 接入页。示例使用占位值,不会执行请求。服务端 Key 不可放入浏览器。
Web Beta 的结账需要明确配置 Stripe Sandbox 测试账号与已发布价格映射。跳转完成不等于支付确认。
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/billing/setup-payment" \  -H "Authorization: Bearer $GROOVE_CUSTOMER_TOKEN" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "customerId": "00000000-0000-4000-8000-000000000001",  "requestId": "00000000-0000-4000-8000-000000000001",  "currency": "USD",  "makeDefault": false}'

响应选项卡列出字段类型,不是响应示例;实际值由客户状态决定。

请求参数

JSON 请求体

requestIduuid必填

你的业务请求 UUID;同一次操作重试复用,新的操作生成新值。

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"

makeDefaultboolean必填

本次操作的 makeDefault 值,类型和约束见字段标注。

customerIduuid可选

Indiana 客户 ID。服务端从已验证身份关联;客户 Token 调用时省略并使用 Token 绑定的客户。

响应字段

成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果;可选字段不可用时省略。

HTTP 200 · application/json

requestIduuid必填

服务端生成的 HTTP 请求 UUID,排查请求时提供这个值。

scopeobject必填

响应实际所属的 App 和环境。Header 只能核对,不能切换 Key 范围。

展开子字段
projectIdstring必填

凭据绑定的 App ID。

minLength: 1

environmentenum必填

独立数据范围:sandbox 或 live。

查看允许值

"sandbox""live"

setupobject必填

本次操作的 setup 值,类型和约束见字段标注。

展开子字段
iduuid必填

本次操作的 id 值,类型和约束见字段标注。

provider"stripe"必填

本次操作的 provider 值,类型和约束见字段标注。

statusenum必填

本次操作的 status 值,类型和约束见字段标注。

查看允许值

"prepared""complete""expired"

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"

makeDefaultboolean必填

本次操作的 makeDefault 值,类型和约束见字段标注。

urluri | null必填

托管结账地址;支付结果由已验证的 provider 通知确认。

createdAtdate-time必填

记录创建时的 ISO 8601 UTC 时间。

expiresAtdate-time必填

ISO 8601 UTC 到期时间;会话和预占到期后不能继续使用。

completedAtdate-time | null必填

本次操作的 completedAt 值,类型和约束见字段标注。

处理错误

常见失败
错误码处理方式
UNAUTHENTICATED核对 Key,或将过期客户 Token 重新签发一次。
FORBIDDEN核对当前 Key 权限与客户访问范围。
INVALID_REQUEST检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH使用凭据绑定的 App 和环境。

常见失败

  • UNAUTHENTICATED

    处理方式
    核对 Key,或将过期客户 Token 重新签发一次。
  • FORBIDDEN

    处理方式
    核对当前 Key 权限与客户访问范围。
  • INVALID_REQUEST

    处理方式
    检查字段类型、UUID、十进制字符串和互斥字段。
  • SCOPE_MISMATCH

    处理方式
    使用凭据绑定的 App 和环境。

相关:完整请求与错误约定·返回接口索引