Z Zise Developers
POST /v1/cards/{id}/freeze

冻结卡片(过渡态 freezing)

Scope cards:write 代会员调用 · 必带 x-on-behalf-of x-idempotency-key

冻结与解冻是两个端点、两个过渡态,不是一个布尔的两个取值。

合并成一个正是那次「解冻后报卡状态无效 + 充值失败」线上故障的成因:

从一个 freezing 看不出终点是 frozen 还是 active

我方同时做两件事:向上游发冻结指令(异步),并把上游的可交易额度

压到 0(同步)。只做前者的话,指令生效之前那张卡照常能刷。

响应里的 status 恒为 freezing(我方本地已落过渡态)。终态由 webhook

推,或由我方当场回读上游压到秒级 —— 不要把 200 当成「已冻结」

请求体为空对象即可({})。

前置条件

  • 卡状态在 active / pending / unactivated 之一(其余一律拒)

路径参数

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

响应

200已受理,卡进入过渡态
{
  "id": "crd_9f2c1b7a-3d51-4a2e-9c08-6b1f0d4e77aa",
  "status": "freezing"
}
400state_invalid 当前状态不能冻结 · product_not_available 供应商不可用 · idempotency_key_required / idempotency_key_invalid上游拒绝(我方与上游认知不一致)目前以 500 api_error 返回。 这一档与 state_invalid 的处置完全不同:后者刷新一下再试, 前者刷新多少次都一样,只能人工。别把两者当同一件事重试。
404not_found 卡不存在或不在这个会员名下

触发的事件

调用样例
curl -X POST 'https://api.zise.com/v1/cards/{id}/freeze' \
  -H 'authorization: Bearer $TOKEN' \
  -H 'x-zise-merchant: $MERCHANT_ID' \
  -H 'x-on-behalf-of: $MEMBER_ID' \
  -H 'x-idempotency-key: $(uuidgen)'
const res = await fetch(
  "https://api.zise.com/v1/cards/{id}/freeze",
  {
    method: "POST",
    headers: {
      "authorization": "Bearer $TOKEN",
      "x-zise-merchant": "MERCHANT_ID",
      "x-on-behalf-of": "MEMBER_ID",
      "x-idempotency-key": "crypto.randomUUID()"
    },
  },
);
// 金额一律按字符串读,不要 JSON.parse 成 number
const data = await res.json();
import requests

res = requests.post(
    "https://api.zise.com/v1/cards/{id}/freeze",
    headers={
        "authorization": "Bearer $TOKEN",
        "x-zise-merchant": "$MERCHANT_ID",
        "x-on-behalf-of": "$MEMBER_ID",
        "x-idempotency-key": "$(uuidgen)"
    },
)
# 金额用 Decimal(str(...)),不要 float
data = res.json()