会员卡核销
对指定会员卡进行消费核销,支持储值卡扣款、次卡扣次、折扣卡消费、套餐卡项目使用等多种核销场景。
请求
POST /open-api/v1/member-cards/{cardId}/write-off路径参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
cardId | long | 是 | 会员卡 ID |
请求体
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
bizType | int | 是 | 业务类型:1-扫码支付 2-消费券核销 3-手动核销 4-次卡扣次 5-折扣消费 6-套餐项目使用 |
storeId | long | 否 | 核销门店 ID |
amount | int | 否 | 核销金额(分),储值卡/折扣卡使用时传入 |
times | int | 否 | 核销次数,次卡使用时传入 |
packageItemName | string | 否 | 套餐项目名称,套餐卡使用时传入 |
bizId | long | 否 | 关联业务 ID |
remark | string | 否 | 备注 |
请求示例
bash
curl -X POST 'https://openapi.example.com/open-api/v1/member-cards/5001/write-off' \
-H 'X-App-Key: ak_1234567890abcdef' \
-H 'X-Timestamp: 1709280000' \
-H 'X-Nonce: a1b2c3d4' \
-H 'X-Sign: calculated_signature' \
-H 'Content-Type: application/json' \
-d '{
"bizType": 3,
"storeId": 2001,
"amount": 5000,
"remark": "面部护理消费"
}'响应
响应参数
返回 Boolean 类型,核销成功返回 true。
响应示例
json
{
"code": 0,
"msg": "success",
"data": true
}不同卡类型核销说明
| 卡类型 | bizType | 必传字段 |
|---|---|---|
| 储值卡扣款 | 3(手动核销)或 1(扫码支付) | amount(核销金额) |
| 次卡扣次 | 4 | times(核销次数) |
| 折扣卡消费 | 5 | amount(消费金额,系统按折扣计算) |
| 套餐卡使用项目 | 6 | packageItemName(套餐项目名称) |
错误码
| 错误码 | 说明 |
|---|---|
OPEN_API_MERCHANT_NOT_COOPERATING | 应用与该商户不存在合作关系 |
OPEN_API_PERMISSION_DENIED | 无 member_card 模块权限 |