开发指南
API
官网
API 2.0
API 2.0 > 7.5 新余额操作 > 7.5.3 余额扣减

7.5.3 余额扣减

开启令牌和权限后可调用。签名方式请查看开发指南
场景描述：余额扣减
零售 餐饮

请求地址

请求方式 版本信息 请求地址
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.customer-decrease-balance 接口方法
Params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
bizId string 是 业务标识（用于余额扣减冲正的时候使用）
customerId string 是 用户id
amount Money（元 ） 是 扣除金额（取到小数点后两位）
appType string 否 appType类型
deviceSn string 否 手机/电脑/收银机识别码
ip string 否 终端ip
opType int 否 操作类型
operatorId int 否 操作员id
operatorName string 否 操作员名称
payPassword string 否 支付密码
productName string 否 商品名称字段
reason string 否 改变原因
remark string 否 流水备注
sellerId int 否 商家id
sellerName string 否 商家名称
storeId int 否 多门店id
storeName string 否 多门店名称
storeSn string 否 多门店编码
usePassword string 否 是否使用密码
customerCode string 否 会员码(customerId和customerCode至少有一个不能为空)
isCheckUserId bool 否 是否比对会员码customerId跟传过来的customerId, 不一致返回检验失败, 一致才进行扣减
isDeductAllBalance bool 否 余额不足时是否扣减全部余额

响应参数

参数 参数类型 描述
bizId string 业务标识
gift_amount Money(元) 扣减后 - 赠送余额
recharge_amount Money(元) 扣减后 - 充值余额
total_amount Money(元) 扣减后 - 总余额
change_gift_amount Money(元) 扣减赠送金额
change_recharge_amount Money（元） 扣减充值金额
userInfo array
 ├avatar string 会员头像
 ├birthday string 会员生日
 ├username string 会员名称
 ├nickname string 会员昵称
 ├phone string 会员手机号
 ├gender string 性别
 ├province int 省：公司统一管理的代号
 ├city int 市：公司统一管理的代号
 ├district int 区：公司统一管理的代号

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "communal.user.customer-decrease-balance",
    "Params": {
        "bizId": "appy31232112",
        "customerId": "383933091455959041",
        "amount": "1",
        "appType": "alipay",
        "deviceSn": "",
        "ip": "",
        "opType": "付款",
        "operatorId": "",
        "operatorName": "",
        "payPassword": "",
        "productName": "",
        "reason": "",
        "remark": "",
        "sellerId": "",
        "sellerName": "",
        "storeId": "",
        "storeName": "",
        "storeSn": "",
        "usePassword": "",
        "customerCode": "",
        "isCheckUserId": "",
        "isDeductAllBalance": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "bizId": "4.80",
        "gift_amount": "4.80",
        "recharge_amount": "4.80",
        "total_amount": "4.80",
        "change_gift_amount": "4.80",
        "change_recharge_amount": "4.80",
        "userInfo": {
            "avatar": "",
            "birthday": "",
            "username": "",
            "nickname": "",
            "phone": "",
            "gender": "",
            "province": "",
            "city": "",
            "district": ""
        }
    }
}

异常示例

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

错误码

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

请求地址

请求方式 版本信息 请求地址
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.customer-decrease-balance 接口方法
Params array 是 业务参数

请求参数

参数 参数类型 是否必填 默认值 描述
bizId string 是 业务标识（用于余额扣减冲正的时候使用）
customerId string 是 用户id
amount Money（元 ） 是 扣除金额（取到小数点后两位）
appType string 否 appType类型
deviceSn string 否 手机/电脑/收银机识别码
ip string 否 终端ip
opType int 否 操作类型
operatorId int 否 操作员id
operatorName string 否 操作员名称
payPassword string 否 支付密码
productName string 否 商品名称字段
reason string 否 改变原因
remark string 否 流水备注
sellerId int 否 商家id
sellerName string 否 商家名称
storeId int 否 多门店id
storeName string 否 多门店名称
storeSn string 否 多门店编码
usePassword string 否 是否使用密码
customerCode string 是 会员码(customerId和customerCode至少有一个不能为空)
isCheckUserId bool 否 是否比对会员码customerId跟传过来的customerId, 不一致返回检验失败, 一致才进行扣减
isDeductAllBalance bool 否 余额不足时是否扣减全部余额
multiMark string 否 门店编码

响应参数

参数 参数类型 描述
bizId string 业务标识
gift_amount Money(元) 扣减后 - 赠送余额
recharge_amount Money(元) 扣减后 - 充值余额
total_amount Money(元) 扣减后 - 总余额
change_gift_amount Money(元) 扣减赠送金额
change_recharge_amount Money（元） 扣减充值金额
userInfo array
 ├avatar string 会员头像
 ├birthday string 会员生日
 ├username string 会员名称
 ├nickname string 会员昵称
 ├phone string 会员手机号
 ├gender string 性别
 ├province int 省：公司统一管理的代号
 ├city int 市：公司统一管理的代号
 ├district int 区：公司统一管理的代号
storeBalance number 总部记账金额/元
shopBalance number 门店记账金额/元

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "communal.user.customer-decrease-balance",
    "Params": {
        "bizId": "appy31232112",
        "customerId": "383933091455959041",
        "amount": "1",
        "appType": "alipay",
        "deviceSn": "",
        "ip": "",
        "opType": "付款",
        "operatorId": "",
        "operatorName": "",
        "payPassword": "",
        "productName": "",
        "reason": "",
        "remark": "",
        "sellerId": "",
        "sellerName": "",
        "storeId": "",
        "storeName": "",
        "storeSn": "",
        "usePassword": "",
        "customerCode": "",
        "isCheckUserId": "",
        "isDeductAllBalance": "",
        "multiMark": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "bizId": "4.80",
        "gift_amount": "4.80",
        "recharge_amount": "4.80",
        "total_amount": "4.80",
        "change_gift_amount": "4.80",
        "change_recharge_amount": "4.80",
        "userInfo": {
            "avatar": "",
            "birthday": "",
            "username": "",
            "nickname": "",
            "phone": "",
            "gender": "",
            "province": "",
            "city": "",
            "district": ""
        },
        "storeBalance": "",
        "shopBalance": ""
    }
}

异常示例

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

错误码

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

免费升级

营销功能、插件持续每月更新开发升级

免费专业培训

每月建站、微信营销、电商等互联网增值培训

7×24小时服务支持

400电话、QQ、微信、在线等多渠道售后支持

 

安徽智迈科技股份有限公司 版权所有 Copyright 2009-2018 皖公网安备 34019202000074号 增值电信业务经营许可证：皖B2-20170075