企迈云-开放平台

API 2.0

API 2.0 > 7.7 会员交易 > 7.7.1 会员交易消费

7.7.1 会员交易消费

开启令牌和权限后可调用。签名方式请查看开发指南

场景描述：余额扣减+优惠券核销

餐饮

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	communal.user.consume	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	描述
bizId	string	是	业务标识对应响应参数的 bizId【冲正时以返回参数中的bizId为准】
channel	string	否	账户名
customerId	string	否	用户id，当couponsCardList是扫码核销码时非必传，其他情况下必传
groupId	int	否	集团ID
couponsCardList	array	是	用户优惠券id，多个 [390962138708451328],和amount参数至少有一个存在
type	int	否	当 type=1时， couponsCardList 传扫码核销码
amount	string	是	余额扣除金额（取到小数点后两位）和couponsCardList至少有一个存在
appType	string	否	appType类型
deviceSn	string	否	手机/电脑/收银机识别码
ip	string	否	终端ip
opType	int	否	操作类型
operatorId	int	否	操作员id
operatorName	string	否	操作员名称
payPassword	string	否	支付密码
productName	string	否	商品名称字段
reason	string	否	改变原因
remark	string	否	流水备注
usePassword	string	否	是否使用密码
points	int	否	扣减积分数
multiMark	string	否	门店编码

响应参数

参数	参数类型	描述
status	bool	成功或失败标识
code	int	成功或失败代码
message	string	描述
bizId	string	业务标识
couponsCardList	array	优惠券核销码对应会员详情中的cardId
gift_amount	string	扣减后 - 赠送余额
recharge_amount	string	扣减后 - 充值余额
total_amount	string	扣减后 - 总余额
change_gift_amount	string	扣减赠送金额
change_recharge_amount	string	扣减充值金额
storeBalance	number	总部记账金额/元
shopBalance	number	门店记账金额/元

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "communal.user.consume",
    "Params": {
        "bizId": "",
        "channel": "",
        "customerId": "",
        "groupId": "",
        "couponsCardList": "",
        "type": "",
        "amount": "",
        "appType": "",
        "deviceSn": "",
        "ip": "",
        "opType": "",
        "operatorId": "",
        "operatorName": "",
        "payPassword": "",
        "productName": "",
        "reason": "",
        "remark": "",
        "usePassword": "",
        "points": "",
        "multiMark": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "status": "true",
        "code": "0",
        "message": "操作成功",
        "bizId": "",
        "couponsCardList": "",
        "gift_amount": "",
        "recharge_amount": "",
        "total_amount": "",
        "change_gift_amount": "",
        "change_recharge_amount": "",
        "storeBalance": "",
        "shopBalance": ""
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}