Z Zise Developers English

销卡(不可逆;剩余余额由我方清退)

POST /v1/cards/{id}/close scope: cards:write
代会员调用 · 必带 x-on-behalf-of 需 x-idempotency-key

不可逆。 受理后的顺序是:把卡内剩余全部退回可用余额(忽略产品最低保留)→ 等清退到账 → 冻结 → 上游销卡。已授权未结算的交易或未结清消费手续费仍会拒绝,让用户等结算。

响应里的 status 是此刻的卡状态,清退还在路上时可能仍是active;closePhase 说明编排走到哪。对一张已经是closed / expired / replaced / closing 的卡重复调用直接回 200(幂等)。

⚠ 销卡之后不能再开回来 —— 会员要卡就得重新走一遍开卡流程(补卡走的是另一条路,见 POST /v1/cards/{id}/replacements)。

前置条件

  • 没有已授权未结算的交易
  • 没有未结清的消费手续费

路径参数

字段类型必填说明
id string 必填 卡 id
字段类型必填说明
x-on-behalf-of string 必填 代哪个会员调用

请求体

字段类型必填说明
reason string 可选 注销原因,落我方留痕(截断到 200 字符)。不影响判定。

响应

200已受理(或这张卡本来就已经结束了 —— 两种同一响应)
{
  "id": "crd_9f2c1b7a-3d51-4a2e-9c08-6b1f0d4e77aa",
  "status": "active",
  "closePhase": "sweeping"
}
400state_invalid 有未结算授权 / 未结清手续费 / 上游拒绝销卡 · product_not_available 供应商不可用 · idempotency_key_required / idempotency_key_invalid
404not_found 卡不存在或不在这个会员名下

会触发的事件

绿 = 终局且是好消息 · 红 = 终局且要处置 · 紫 = 中间态。点进去看事件体与验签。

请求
curl -X POST 'https://api.zinfra.vip/v1/cards/{id}/close' \
  -H 'x-auth-token: Bearer $TOKEN' \
  -H 'x-on-behalf-of: $MEMBER_ID' \
  -H 'x-idempotency-key: $IDEMPOTENCY_KEY' \
  -H 'content-type: application/json' \
  -d '{
    "reason": "用户不再需要"
  }'
const res = await fetch("https://api.zinfra.vip/v1/cards/{id}/close", {
  method: "POST",
  headers: {
    "x-auth-token": "Bearer $TOKEN",
    "x-on-behalf-of": "$MEMBER_ID",
    "x-idempotency-key": "$IDEMPOTENCY_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "reason": "用户不再需要"
  }),
});
// 金额按字符串读,别让它变成 number
const data = await res.json();
import requests

res = requests.post(
    "https://api.zinfra.vip/v1/cards/{id}/close",
    headers={
        "x-auth-token": "Bearer $TOKEN",
        "x-on-behalf-of": "$MEMBER_ID",
        "x-idempotency-key": "$IDEMPOTENCY_KEY",
        "content-type": "application/json",
    },
    json={
      "reason": "用户不再需要"
    },
)
# 金额用 Decimal(str(...)),不要 float
data = res.json()
req, _ := http.NewRequest("POST", "https://api.zinfra.vip/v1/cards/{id}/close",
    strings.NewReader(`{
  "reason": "用户不再需要"
}`))
req.Header.Set("x-auth-token", "Bearer $TOKEN")
req.Header.Set("x-on-behalf-of", "$MEMBER_ID")
req.Header.Set("x-idempotency-key", "$IDEMPOTENCY_KEY")
req.Header.Set("content-type", "application/json")
res, err := http.DefaultClient.Do(req)
// 金额字段用 string 接,不要 float64
HttpRequest req = HttpRequest.newBuilder()
    .uri(URI.create("https://api.zinfra.vip/v1/cards/{id}/close"))
    .header("x-auth-token", "Bearer $TOKEN")
    .header("x-on-behalf-of", "$MEMBER_ID")
    .header("x-idempotency-key", "$IDEMPOTENCY_KEY")
    .header("content-type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "reason": "用户不再需要"
}
"""))
    .build();
// 金额字段用 String / BigDecimal,不要 double
$ch = curl_init('https://api.zinfra.vip/v1/cards/{id}/close');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'x-auth-token: Bearer $TOKEN',
    'x-on-behalf-of: $MEMBER_ID',
    'x-idempotency-key: $IDEMPOTENCY_KEY',
    'content-type: application/json',
  ],
  CURLOPT_POSTFIELDS => <<<'JSON'
{
  "reason": "用户不再需要"
}
JSON,
]);
$res = curl_exec($ch);
// 金额用 bcmath / 字符串,不要 floatval
200
{
  "id": "crd_9f2c1b7a-3d51-4a2e-9c08-6b1f0d4e77aa",
  "status": "active",
  "closePhase": "sweeping"
}