POST
/v1/cards/{id}/close
销卡(不可逆)
Scope
cards:write
代会员调用 · 必带 x-on-behalf-of
需 x-idempotency-key
不可逆,且必须先清空卡内资金。我方在动手之前会回读一次上游余额
(我方快照可能过期)——查不到余额就不销,宁可让你重试一次,
也不销掉一张对不上账的卡(对账证据只在销卡前拿得到)。
已授权未结算的交易还会扣款,有的话我方拒绝销卡,让用户等结算。
status 恒为 closing(过渡态);终态由上游回调收敛。
对一张已经是 closed / expired / replaced / closing 的卡重复调用
直接回 200(幂等),不会再发一次上游请求。
⚠ 销卡之后不能再开回来 —— 会员要卡就得重新走一遍开卡流程
(补卡走的是另一条路,见 POST /v1/cards/{id}/replacements)。
前置条件
- 卡内余额为 0(共享额度卡:可用额度 + 行政锁 + 预留合计为 0)
- 没有已授权未结算的交易
- 上游余额能查得到(查不到一律拒)
路径参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id |
string | 必填 | 卡 id |
请求头
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
x-on-behalf-of |
string | 必填 | 代哪个会员调用 |
请求体
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
reason |
string | 可选 | 注销原因,落我方留痕(截断到 200 字符)。不影响判定。 |
响应
200已受理(或这张卡本来就已经结束了 —— 两种同一响应)
{
"id": "crd_9f2c1b7a-3d51-4a2e-9c08-6b1f0d4e77aa",
"status": "closing"
}400
state_invalid 上游拒绝销卡 · product_not_available 供应商不可用 ·
idempotency_key_required / idempotency_key_invalid
⚠ 「卡内还有钱」「有未结算交易」「上游余额查不到」目前都以
500 api_error 返回(内部有码,未登记进对外目录)——
而这三种正是这个端点最常见的拒绝理由。先调 close-check,
按它的结论决定要不要发这个请求,比解读 500 可靠得多。404
not_found 卡不存在或不在这个会员名下触发的事件
card.status.updated— 看事件体
调用样例
curl -X POST 'https://api.zise.com/v1/cards/{id}/close' \
-H 'authorization: Bearer $TOKEN' \
-H 'x-zise-merchant: $MERCHANT_ID' \
-H 'x-on-behalf-of: $MEMBER_ID' \
-H 'x-idempotency-key: $(uuidgen)' \
-H 'content-type: application/json' \
-d '{
"reason": "用户不再需要"
}'
const res = await fetch(
"https://api.zise.com/v1/cards/{id}/close",
{
method: "POST",
headers: {
"authorization": "Bearer $TOKEN",
"x-zise-merchant": "MERCHANT_ID",
"x-on-behalf-of": "MEMBER_ID",
"x-idempotency-key": "crypto.randomUUID()",
"content-type": "application/json"
},
body: JSON.stringify({
"reason": "用户不再需要"
}),
},
);
// 金额一律按字符串读,不要 JSON.parse 成 number
const data = await res.json();
import requests
res = requests.post(
"https://api.zise.com/v1/cards/{id}/close",
headers={
"authorization": "Bearer $TOKEN",
"x-zise-merchant": "$MERCHANT_ID",
"x-on-behalf-of": "$MEMBER_ID",
"x-idempotency-key": "$(uuidgen)",
"content-type": "application/json"
},
json={
"reason": "用户不再需要"
},
)
# 金额用 Decimal(str(...)),不要 float
data = res.json()