目录
- 3.1会员营销
- 3.1.1会员账户信息查询
- 3.1.2会员充值
- 3.1.5会员注册
- 3.1.6统一登录注册
- 3.1.7会员商户优惠试算
- 3.1.10会员基本信息查询
- 3.1.11会员快捷支付签约申请
- 3.1.12会员快捷支付签约确认
- 3.1.13第三方优惠试算
- 3.1.16会员绑储值卡
- 3.1.17会员实名
- 3.1.18会员充值查询
- 3.1.21会员绑定实体卡(开卡)
- 3.1.22会员卡密码修改
- 3.1.23会员调账
- 3.1.24会员调账查询
- 3.1.25会员状态变更
- 3.1.26发送短信验证码
- 3.1.28会员消费查询
- 3.1.29会员消费撤销
- 3.1.30会员消费撤销查询
- 3.1.31会员无密码消费
- 3.1.32会员消费
- 3.1.34会员信息更新
- 3.1.35会员账户流水
- 3.1.36银行卡解绑
- 3.1.37 获取用户基本信息(OAuth2)
- 3.1.38 获取基础营销授权链接
- 3.3.1 H5页面调用绑定微信和手机号(GET)
- 3.3.2 H5页面调用绑定微信和外部顾客编号(GET)
3.1会员营销
3.1.1会员账户信息查询
根据会员手机号等信息查询会员余额、积分、优惠券等信息。
接口方法:
method: allinpay.shopoint.memberService.memberQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
idType |
String |
是 |
|
会员账号类型 |
1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 5- 外部会员ID 6- 内部会员ID |
memberId |
String |
是 |
|
会员账号 |
|
shopId |
String |
否 |
|
店铺ID |
输入则couponList只返回该店铺下的可用优惠券 |
couponStatus |
Integer |
否 |
|
|
0 - 全部有效卡券 1 – 当前可用卡券 6 – 无效卡券 不填默认为1 |
shopCode |
String |
否 |
|
店铺号 |
与shopId功能相同,shopId和shopCode同时输入则只取shopId |
operUserId |
String |
否 |
|
收银员 |
输入则couponList只返回该收银员所在店铺的可用优惠券,如shopId和operUserId同时输入则,operUserId应属于shopId店铺 |
statusList |
List |
否 |
|
券状态,若有传入则忽略入参couponStatus |
0- 有效 1- 已冻结 2- 已作废 3- 已核销 5– 转赠中 9– 退款中 |
balanceGt |
Integer |
否 |
|
余额,单位(分) |
-1,0,正数 |
validityBeginDateLe |
String |
否 |
|
可用开始日期小于等于该日期 |
yyyy-MM-dd HH:mm:ss |
validityBeginDateGe |
String |
否 |
|
可用开始日期大于等于该日期 |
yyyy-MM-dd HH:mm:ss |
validityEndDateLe |
String |
否 |
|
可用结束日期小于等于该日期 |
yyyy-MM-dd HH:mm:ss |
validityEndDateGe |
String |
否 |
|
可用结束日期大于等于该日期 |
yyyy-MM-dd HH:mm:ss |
pageNo |
Integer |
否 |
|
券列表的页码 |
取值范围为1到1000, 非法值将会重设为默认值. 默认值1 |
pageSize |
Integer |
否 |
|
券列表的每页数量 |
取值范围为1到200, 非法值将会重设为默认值. 默认值200 |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
是 |
|
错误信息 |
|
||
data |
cardNo |
|
String |
是 |
|
实体会员卡号 |
|
orgId |
|
String |
是 |
|
机构号 |
|
|
balance |
|
String |
是 |
|
余额 |
单位:元 |
|
status |
|
Integer |
是 |
|
会员状态 |
0:正常 1:冻结 |
|
score |
|
String |
是 |
|
积分 |
|
|
couponTotal |
|
Integer |
是 |
|
券总数量 |
|
|
couponList |
|
|
是 |
|
可用券列表 |
|
|
couponList |
templateId |
Integer |
是 |
|
模板ID |
|
|
cardNo |
Integer |
否 |
|
卡号 |
|
||
couponNo |
String |
是 |
|
券号 |
|
||
couponName |
String |
是 |
|
券名称 |
|
||
couponType |
String |
是 |
|
券类型 |
0 现金卡 1 代金券 2 计次券 3 满减活动券 |
||
unit |
String |
否 |
|
券单位 |
计次券有效 |
||
balance |
BigDecimal |
是 |
|
余额 |
|
||
validityBeginDate |
String |
是 |
|
有效期起始日期 |
|
||
validityEndDate |
String |
是 |
|
有效期终止日期 |
|
||
hasPassword |
Boolean |
是 |
|
卡是否有密码
|
true:有密码 false:无密码 |
||
unusableReason |
String |
否 |
|
不可用券原因 |
|
||
status |
Integer |
是 |
|
券状态 |
态,0 - 有效 1 - 冻结 2 - 已作废 3 - 已核销 100 - 待生成 |
||
rangeTime |
String |
否 |
|
可用时间 |
不返回表示不限制,否则解析字符串获取设定规则 示例: 9:30~10:30,17:00~19:00 |
||
rangeDate |
Integer |
否 |
|
可用日期 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。
|
||
rangeDayOfWeek |
Integer |
否 |
|
周几可用 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。 |
||
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
满减券使用 |
||
usableMaxNum |
Integer |
否 |
|
每笔订单最大优惠金额 |
满减券使用 |
||
instruction |
String |
否 |
|
券使用须知 |
|
||
|
|
|
|
|
|
请求示例
{"idType":"1","memberId":"13882177104"}
响应示例
{
"code": 0,
"data": {
"templateId": 794,
"couponNo": "10000000000001607134",
"couponName": "商品删除测试",
"couponType": 0,
"balance": 1,
"unit": null,
"rangeDate": 2102013412,
"rangeDayOfWeek": 42,
"rangeTime": “9:30~10:30,19:30~22:30”,
"validityType": null,
"validityBeginDate": [
2020,
4,
7,
0,
0
],
"validityEndDate": [
2020,
5,
7,
0,
0
]
},
"token": "QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs"
}
3.1.2会员充值
依据会员标识对会员积分及余额进行充值。
method: allinpay.shopoint.memberService.memberRecharge
version: 1.0
业务请求参数
字段名 |
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
orderId |
|
String |
是 |
|
外部充值订单号 |
|
rechargeList |
|
List |
是 |
|
充值列表 |
|
idType |
String |
是 |
|
会员账号类型 |
1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 5- 外部会员ID 6 内部会员ID |
|
memberId |
String |
是 |
|
会员账号 |
|
|
reChargeType |
String |
是 |
|
充值类型 |
1- 余额充值 2- 积分充值 |
|
amount |
String |
是 |
|
充值数量 |
余额充值:单位元 积分充值:积分数量 |
|
consumeShopId |
Integer |
否 |
|
充值店铺Id |
|
|
consumeShopCode |
String |
是 |
|
充值店铺编号 |
同时传consumeShopId和consumeShopCode时,consumeShopCode不生效 |
|
remark |
String |
否 |
255 |
备注 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
|
错误信息 |
|
data |
Boolean |
是 |
|
|
True |
请求示例
{“rechargeList”:[{“idType":"1","memberId":"13882177104","reChargeType":"1","amount":"10"}]}
响应示例
{
"code": 0,
"data": true,
"token": "QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs"
}
3.1.5会员注册
method: allinpay.shopoint.memberService.memberRegister
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
mobile |
String |
是 |
|
手机号 |
|
openid |
String |
否 |
|
微信机构公众号openid |
|
wechatAppOpenId |
String |
否 |
|
微信小程序OpenId |
|
cardNo |
String |
否 |
|
会员卡号 |
|
memberLevelId |
Integer |
否 |
|
会员等级 |
|
name |
String |
否 |
|
姓名 |
|
gender |
String |
否 |
|
性别 |
|
nickName |
String |
否 |
|
昵称 |
|
birthday |
String |
否 |
|
生日 |
示例:1990-03-09 |
carLicenseNo |
String |
否 |
|
车牌号 |
|
refereeSysno |
Integer |
否 |
|
推荐人ID |
|
referee |
String |
否 |
|
推荐人 |
|
bindShopId |
Integer |
否 |
|
归属门店Id |
对接方为智慧门店时有效;对接方为通惠时无效 同时传入归属门店Id和归属门店编号时,以Id为准 |
bindShopCode |
String |
否 |
|
归属门店编号 |
对接方为智慧门店时有效;对接方为通惠时无效 同时传入归属门店Id和归属门店编号时,以Id为准 |
remark |
String |
否 |
|
备注 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|
msg |
String |
是 |
|
错误信息 |
|
|
data |
customerId |
Integer |
是 |
|
会员ID |
|
请求示例
{"mobile":"18616721282","cardNo":"138821"}
响应示例
{
"code": 0,
"data": {
"customerId": 1,
}
}
3.1.6统一登录注册
接口使用方式推荐
method: allinpay.shopoint.memberService.memberUnionLogin
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
userId |
String |
否 |
180 |
用户唯一编号 |
Scope=4时必传 |
mobile |
String |
否 |
11 |
手机号 |
userId与mobile必传一个,加密传输(详见2.3.4) |
scope |
Integer |
是 |
4 |
登录系统类型 |
1-微商城C端 2 - 小微商户ISV平台 3 - 机构商户ISV平台 4-商户后台 5-微商城B端 6-小微B端 |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|
msg |
String |
是 |
|
错误信息 |
|
|
data |
customerId |
Integer |
否 |
|
会员ID |
Scope=1时必填 |
userId |
String |
否 |
|
后台用户ID |
Scope=4时必填 |
|
orgId |
Integer |
是 |
|
机构ID |
|
|
authToken |
String |
是 |
|
会员登录token |
|
|
|
expire |
Integer |
是 |
|
Token有效时间 |
单位:秒 |
请求示例
{"mobile":"18616721282"}
响应示例
{
"code": 0,
"data": {
"customerId": 1,
" orgId": 1,
" authToken": "OAccFQ9LZ9+B1Jhn9Tb1v37GssdmohZhAdjgYTWz"
}
}
跳转地址
序号 |
产品 |
环境 |
模块 |
跳转地址示例 |
说明 |
1 |
通惠 |
测试 |
首页 |
https://dms-test.shopoint.cn/wxmall/index.html#/bank?orgId=<机构号>&authToken=<authToken> |
C端首页 |
我的卡券 |
https://dms-test.shopoint.cn/wxmall/index.html#/BankCoupon?orgId=<机构号>&authToken=<authToken> |
C端用户卡包 |
|||
我的 |
https://dms-test.shopoint.cn/wxmall/index.html#/BankCenter?orgId=<机构号>&authToken=<authToken> |
C端用户个人中心 |
|||
客户经理 |
https://dms-test.shopoint.cn/wxmall/index.html#/bankdgIndex?orgId=<机构号>&authToken=<authToken> |
银行客户经理端首页 |
|||
机构后台 |
https://dms-test.shopoint.cn/mcht/index.html#/home?authToken={authToken} |
银行机构后台首页 |
|||
生产 |
首页 |
https://dms.shopoint.cn/wxmall/index.html#/bank?orgId=<机构号>&authToken=<authToken> |
C端首页 |
||
我的卡券 |
https://dms.shopoint.cn/wxmall/index.html#/BankCoupon?orgId=<机构号>&authToken=<authToken> |
C端用户卡包 |
|||
我的 |
https://dms.shopoint.cn/wxmall/index.html#/BankCenter?orgId=<机构号>&authToken=<authToken> |
C端用户个人中心 |
|||
客户经理 |
https://dms.shopoint.cn/wxmall/index.html#/bankdgIndex?orgId=<机构号>&authToken=<authToken> |
银行客户经理端首页 |
|||
机构后台 |
https://dms.shopoint.cn/mcht/index.html#/home?authToken={authToken} |
银行机构后台首页 |
|||
2 |
智慧门店 |
测试 |
首页 |
https://dms-test.shopoint.cn/wxmall/index.html#/?orgId=<机构号>&authToken=<authToken> |
C端首页 |
我的卡券 |
https://dms-test.shopoint.cn/wxmall/index.html#/cardCouponWalletIndex?orgId=<机构号>&authToken=<authToken> |
C端用户卡包 |
|||
我的 |
https://dms-test.shopoint.cn/wxmall/index.html#/UserIndex?orgId=<机构号>&authToken=<authToken> |
C端用户个人中心 |
|||
导购 |
https://dms-test.shopoint.cn/wxmall/index.html#/dgIndex?orgId=<机构号>&authToken=<authToken> |
导购端首页 |
|||
商户后台 |
https://dms-test.shopoint.cn/mcht/index.html#/home?authToken={authToken} |
管理后台首页 |
|||
门店消费 |
https://dms-test.shopoint.cn/wxmall/index.html#/orderOffline?orgId=<机构号>&authToken=<authToken> |
C端用户线下消费列表 |
|||
|
|
|
|||
生产 |
首页 |
https://dms.shopoint.cn/wxmall/index.html#/?orgId=<机构号>&authToken=<authToken> |
C端首页 |
||
我的卡券 |
https://dms.shopoint.cn/wxmall/index.html#/cardCouponWalletIndex?orgId=<机构号>&authToken=<authToken> |
C端用户卡包 |
|||
我的 |
https://dms.shopoint.cn/wxmall/index.html#/UserIndex?orgId=<机构号>&authToken=<authToken> |
C端用户个人中心 |
|||
导购 |
https://dms.shopoint.cn/wxmall/index.html#/dgIndex?orgId=<机构号>&authToken=<authToken> |
导购端首页 |
|||
商户后台 |
https://dms.shopoint.cn/mcht/index.html#/home?authToken={authToken} |
管理后台首页 |
|||
门店消费 |
https://dms.shopoint.cn/wxmall/index.html#/orderOffline?orgId=<机构号>&authToken=<authToken> |
C端用户线下消费列表 |
|||
|
|
|
|||
3 |
ISV |
测试 |
收银台 |
https://dms-api-test.shopoint.cn/shopoint-micro-web/isv/checkout?authtoken=<authToken>[&其他参数] |
智慧小店ISV收银台 |
生产 |
收银台 |
https://dms-api.shopoint.cn/shopoint-micro-web/isv/checkout?authtoken=<authToken>[&其他参数] |
智慧小店ISV收银台 |
3.1.7会员商户优惠试算
通过上传订单金额、消费门店、会员唯一标识查询会员的可用权益、权益优惠金额、可用金额、积分、积分抵现最大金额、可用券明细。
接口方法:
method: allinpay.shopoint.memberService.memberCalculate
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
idType |
String |
是 |
|
会员账号类型 |
1-手机号 2-会员卡号 3-Openid 4-会员动态码 5-外部会员ID 6-内部会员ID |
memberId |
String |
是 |
|
会员账号 |
|
shopId |
String |
否 |
|
店铺ID |
输入则couponList只返回该店铺下的可用优惠券 |
shopCode |
String |
否 |
|
店铺号 |
与shopId功能相同,shopId和shopCode同时输入则只取shopId,二者必输一个 |
amount |
String |
是 |
|
订单金额 |
单位元:最多两位小数 |
amountOut |
String |
否 |
|
不参与优惠金额 |
|
queryType |
Integer |
是 |
|
查询账户范围 |
0全部、1余额、2积分、3券列表、4优惠金额,可组合“,”分隔 |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
是 |
|
错误信息 |
|
||
data |
discountAmount |
String |
否 |
|
优惠金额 |
单位: 元 |
|
balance |
String |
否 |
|
余额 |
单位:元 |
||
score |
String |
否 |
|
积分 |
|
||
allowScorePayment |
Boolean |
否 |
|
是否允许积分支付 |
|
||
scoreAmount |
String |
否 |
|
积分兑换的基数可兑换的金额 |
单位:元
|
||
scoreQuantity |
Integer |
否 |
|
积分兑换基数 |
|
||
couponList |
|
|
否 |
|
可用券列表 |
|
|
templateId |
Integer |
是 |
|
模板ID |
|
||
couponNo |
String |
是 |
|
券号 |
|
||
couponName |
String |
是 |
|
券名称 |
|
||
couponType |
String |
是 |
|
券类型 |
0 现金卡 1 代金券 2 计次券 3 满减活动券 |
||
unit |
String |
否 |
|
券单位 |
满减券有效 |
||
balance |
BigDecimal |
是 |
|
余额 |
|
||
validityBeginDate |
String |
是 |
|
有效期起始日期 |
|
||
validityEndDate |
String |
是 |
|
有效期终止日期 |
|
||
hasPassword |
Boolean |
是 |
|
卡是否有密码
|
true:有密码 false:无密码 |
||
unusableReason |
String |
否 |
|
不可用券原因 |
|
||
status |
Integer |
是 |
|
券状态 |
态,0 - 有效 1 - 冻结 2 - 已作废 3 - 已核销 100 - 待生成 |
||
rangeTiem |
String |
否 |
|
可用时间 |
不返回表示不限制,否则解析字符串获取设定规则 示例: 9:30~10:30,17:00~19:00 |
||
rangeDate |
Integer |
否 |
|
可用日期 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。 |
||
rangeDayOfWeek |
Integer |
否 |
|
周几可用 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。 |
||
usableAmount |
BigDecimal |
否 |
|
每满多少金额可以使用1张 |
满减券使用 |
||
usableMaxNum |
Integer |
否 |
|
每笔订单最大优惠金额 |
满减券使用 |
||
instruction |
String |
否 |
|
券使用须知 |
|
请求示例
{"idType":"1","memberId":"13882177104"}
响应示例
{
"code": 0,
"data": {
"templateId": 794,
"couponNo": "10000000000001607134",
"couponName": "商品删除测试",
"couponType": 0,
"balance": 1,
"unit": null,
"rangeDate": 2102013412,
"rangeDayOfWeek": 42,
"rangeTime": “9:30~10:30,19:30~22:30”,
"validityType": null,
"validityBeginDate": [
2020,
4,
7,
0,
0
],
"validityEndDate": [
2020,
5,
7,
0,
0
]
},
"token": "QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs"
}
3.1.10会员基本信息查询
根据会员手机号等信息查询会员基本信息。
接口方法:
method: allinpay.shopoint.memberService.memberBasicQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
idType |
String |
是 |
4 |
会员账号类型 |
1-手机号 2-会员卡号 3-Openid 4-会员动态码 5-外部会员ID 6-内部会员ID 7-会员唯一ID |
memberId |
String |
是 |
180 |
会员账号 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|
msg |
String |
是 |
|
错误信息 |
|
|
data |
cardNo |
String |
是 |
|
实体卡号 |
|
mobile |
String |
是 |
|
手机号 |
|
|
unionId |
String |
否 |
|
会员唯一ID |
|
|
openId |
String |
否 |
|
用户机构公众号openid |
|
|
wechatAppOpenId |
String |
否 |
|
用户微信小程序openId |
|
|
qrcode |
String |
否 |
|
用户动态二维码 |
|
|
status |
Integer |
是 |
|
会员状态 |
0:正常 1:冻结 |
|
score |
String |
否 |
|
用户可用积分 |
|
|
memberLevelId |
Integer |
是 |
|
会员等级ID |
|
|
memberLevel |
String |
是 |
|
会员等级 |
|
|
name |
String |
否 |
|
姓名 |
|
|
gender |
String |
否 |
|
性别 |
|
|
nickName |
String |
否 |
|
昵称 |
|
|
carLicenseNo |
String |
否 |
|
车牌号 |
|
|
refereeSysno |
Integer |
否 |
|
导购推荐人ID |
|
|
referee |
String |
否 |
|
导购推荐人 |
|
|
refereeCustomerId |
Integer |
否 |
|
会员推荐人ID |
|
|
refereeCustomer |
String |
否 |
|
会员推荐人 |
|
|
bindFromShopId |
Integer |
否 |
|
推荐门店ID |
|
|
bindFromShopName |
String |
否 |
|
推荐门店 |
|
|
customerId |
Integer |
是 |
|
会员编号ID |
|
|
customerName |
String |
否 |
|
会员名称 |
|
|
createTime |
String |
否 |
|
会员注册时间 |
yyyy-MM-dd HH:mm:ss |
请求示例
{“idType”:”1”,”memberId”:”13882177104”}
响应示例
{
“code”: 0,
“data”: {
“cardNo”: “121222432432412”,
“mobile”: “13882177104”,
“memberLevelId”: 13131,
“memberLevel”: “1”,
“customerId”: 1
},
“token”: “QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs”
}
3.1.11会员快捷支付签约申请
会员发起快捷支付签约申请,由银联或者银行发送短信验证码。
接口方法:
method: allinpay.shopoint.memberService.quickPayAgreeApply
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
memberType |
String |
是 |
2 |
会员账号类型 |
1-手机号 2-会员卡号 3-openid 4-会员动态码 5-外部会员ID 6-内部会员ID |
memberId |
String |
是 |
40 |
会员账号 |
|
bankOrgId |
Integer |
否 |
11 |
银行机构Id |
银行机构对接此接口可以不传 |
acctType |
String |
是 |
2 |
卡类型 |
00: 借记卡 02: 准贷记卡 / 贷记卡 |
acctNo |
String |
是 |
明文长度20 |
银行卡号 |
加密传输(详见2.3.4) |
idType |
String |
是 |
1 |
证件类型。目前只支持身份证。 |
0: 身份证 2: 护照 5: 港澳通行证 6: 台湾通行证 |
idNo |
String |
是 |
明文长度22 |
证件号 |
末尾是X,必须大写,加密传输(详见2.3.4) |
acctName |
String |
是 |
20 |
户名 |
|
mobile |
String |
是 |
11 |
签约手机号 |
|
validDate |
String |
否 |
明文长度4 |
有效期。acctType为02时必填 |
格式:Mmyy,加密传输(详见2.3.4) |
cvv2 |
String |
否 |
明文长度4 |
CVV2。acctType为02时必填 |
加密传输(详见2.3.4) |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|
msg |
String |
是 |
|
错误信息 |
|
|
data |
requestId |
Integer |
是 |
|
签约协议Id |
|
请求示例
{“customerId”: 12345, “bankOrgId”: 1234, “orgId”: 1234, “acctType”: “00”, “acctNo”: “xxxxxxxxxxxxxxxxxxxxxxx”, “idType”: “1”, “idNo”: “yyyyyyyyyyyyyyyyyyyy”, “acctName: “张三”, “mobile”: “13900000000”}
响应示例
{“requestId”: 12345}
3.1.12会员快捷支付签约确认
会员传入短信验证码发起快捷支付签约确认。
接口方法:
method: allinpay.shopoint.memberService.quickPayAgreeConfirm
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
requestId |
Integer |
是 |
11 |
快捷支付签约申请接口返回的请求Id |
|
validDate |
String |
否 |
明文长度4 |
有效期。acctType为02时必填 |
格式:Mmyy,加密传输(详见2.3.4) |
cvv2 |
String |
否 |
明文长度4 |
CVV2。acctType为02时必填 |
加密传输(详见2.3.4) |
smsCode |
String |
是 |
10 |
短信验证码 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|
Msg |
String |
是 |
|
错误信息 |
|
|
data |
agreeId |
String |
是 |
|
协议编号 |
加密传输(详见2.3.4) |
bankCode |
String |
是 |
|
银行代码 |
|
|
bankName |
String |
否 |
|
银行名称 |
|
请求示例
{“requestId”: 12345, “bankOrgId”: 1234, “orgId”: 1234, “smsCode”: “000000”}
响应示例
{“agreeId”: “xxxxxxxxx”, “bankCode”: “0308”, “bankName”: “招商银行”}
3.1.13第三方优惠试算
通过上传订单金额、消费门店、会员唯一标识查询会员在第三方机构的可用权益、权益优惠金额、可用券明细。
接口方法:
method: allinpay.shopoint.memberService.memberCalculateWithinCollaborator
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
idType |
String |
是 |
会员账号类型 |
1手机号 2会员卡号 3-Openid 4-会员动态码 5-外部会员ID 6-内部会员ID 7-会员唯一ID |
memberId |
String |
是 |
会员账号 |
|
amount |
String |
是 |
订单金额 |
单位元:最多两位小数 |
amountOut |
String |
否 |
不参与优惠金额 |
|
shopId |
String |
否 |
店铺ID |
输入则返回店铺参与的活动 同时输入则只取shopId 如果都不输入,则活动设置时必须涵盖该机构所有店铺才能带出该活动 |
shopCode |
String |
否 |
店铺号 |
|
queryType |
Integer |
是 |
查询账户范围 |
0全部、1余额、2积分、3券列表、4优惠金额,可组合“,”分隔 |
业务响应参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
|||||
code |
Integer |
是 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|||||
msg |
String |
是 |
错误信息 |
|
|||||
Data
|
collaboratorOrgs |
collaboratorOrgId |
Integer |
是 |
第三方机构ID |
|
|||
collaboratorOrgName |
String |
是 |
第三方机构名 |
|
|||||
collaboratorOrgLogo |
String |
否 |
第三方机构logo地址 |
|
|||||
promotions |
discountAmount |
BigDecimal |
否 |
仅为打折满减活动优惠金额。 券活动优惠金额见:couponDiscounts.discountAmount |
单位: 元 |
||||
promotionId |
Integer |
是 |
活动ID |
|
|||||
promotionName |
String |
是 |
活动名称 |
|
|||||
promotionType |
Integer |
是 |
活动类型 |
10,银行返券 11,银行打折 12,银行满减 13,银行领券 14,银行售券 20,银联礼券 21,微信打折 22,微信满减 23,微信领券 31,云闪付打折 32,云闪付满减
|
|||||
instruction |
String |
否 |
活动说明 |
|
|||||
couponDiscounts |
couponTemplateId |
Integer |
否 |
卡券模板Id |
|
||||
|
couponName |
String |
否 |
卡券名称 |
|
||||
|
discountAmount |
BigDecimal |
否 |
优惠金额 |
|
||||
|
count |
Integer |
否 |
可使用数量 |
|
||||
|
coupons |
couponNo |
String |
否 |
券号 |
|
|||
couponId |
Integer |
否 |
券ID |
|
|||||
couponType |
Integer |
否 |
券类型 |
0 现金卡 1 代金券 3 满减券 |
|||||
unit |
String |
否 |
券单位 |
满减券有效 |
|||||
balance |
BigDecimal |
否 |
券余额 |
|
|||||
validityBeginDate |
String |
是 |
有效期起始日期 |
|
|||||
validityEndDate |
String |
是 |
有效期终止日期 |
|
|||||
hasPassword |
Boolean |
是 |
卡是否有密码
|
true:有密码 false:无密码 |
|||||
unusableReason |
String |
否 |
不可用券原因 |
|
|||||
status |
Integer |
是 |
券状态 |
态,0 - 有效 1 - 冻结 2 - 已作废 3 - 已核销 100 - 待生成 |
|||||
rangeTime |
String |
否 |
可用时间 |
不返回表示不限制,否则解析字符串获取设定规则 示例: 9:30~10:30,17:00~19:00 |
|||||
rangeDate |
Integer |
否 |
可用日期 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getDatesInt方法。 |
|||||
rangeDayOfWeek |
Integer |
否 |
周几可用 |
不返回表示不限制,否则解析字符串获取设定。具体解析方法请参考SDK工具包中的DateUtils.getWeeksInt方法。 |
|||||
usableAmount |
BigDecimal |
否 |
每满多少金额可以使用1张 |
满减券使用 |
|||||
usableMaxNum |
Integer |
否 |
每笔订单最多使用多想张 |
满减券使用 |
|||||
instruction |
String |
否 |
券使用须知 |
|
|||||
|
|
|
|
|
请求示例
{"idType":"1","memberId":"13880702997","amount":"100","amountOut":"","shopId":"147","queryType":"0"}
响应示例
{
"code": "0",
"data":"{"collaboratorOrgs":[{"promotions":[{"promotionName":
"内部积分抵扣0707","promotionType":16,"couponDiscounts":[],"discountAmount":0.00},{"promotionName":"8.10积分抵扣活动","promotionType":16,"couponDiscounts":[],"discountAmount":0.00}],"collaboratorOrgName":"通惠商城","collaboratorOrgId":100152}]}",
"sign": "fdTb1ooBwATzTo1o3AB6shhJcCToqIDsrPQF3J1dTXLHW+YL8PPLZ8f6kohCu4w3Y2njlvOH/9CrU4G/sEVdylmuwr77JRGNMgKku29XvX6rihR/eMrLP3Wok9yfF6oukSpuRFpGeB6hoyHE+y+vn4JlK0u6vSNa/ywvCKBDYks="
}
3.1.16会员绑储值卡
method: allinpay.shopoint.memberService.memberBindCard
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
mobile |
String |
是 |
|
手机号 |
|
cardNo |
String |
是 |
|
储值卡号 |
|
passwd |
String |
是 |
|
密码 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
code |
Integer |
是 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
错误信息 |
|
data |
Boolean |
是 |
true为绑卡成功 |
|
请求示例
{"mobile":"18616721282","cardNo":"138821"}
响应示例
{
"code": 0,
"data": true
}
3.1.17会员实名
记录和修改会员实名信息
method: allinpay.shopoint.memberService.memberRealName
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
mobile |
String |
是 |
|
手机号 |
|
name |
String |
是 |
|
姓名 |
|
identityType |
Int |
是 |
|
证件类型 |
1.身份证 |
identityNo |
String |
是 |
|
证件号码 |
|
gender |
String |
否 |
|
性别 |
男/女 |
career |
String |
否 |
|
职业 |
|
address |
String |
否 |
|
住址 |
|
|
String |
否 |
|
电子邮箱 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|
msg |
String |
是 |
|
错误信息 |
|
|
data |
customerId |
Integer |
是 |
|
会员ID |
|
请求示例
{"mobile":"18616721282","name":"张三"}
响应示例
{
"code": 0,
"data": {
"customerId": 50806
},
"token": "DlRXdIjEBLRLCJgwTP37sZW6ls--NflxVS2-KUHl"
}
3.1.18会员充值查询
针对接口3.1.2的余额和积分的充值结果查询。
method: allinpay.shopoint.memberService.memberRechargeQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
orderId |
String |
是 |
60 |
外部充值订单号 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
否 |
|
错误信息 |
|
||
data |
orderId |
String |
否 |
|
外部充值订单号 |
|
|
records |
List |
否 |
|
充值明细列表 |
|
||
|
reChargeType |
Integer |
是 |
|
充值类型 |
1-余额充值 2-积分充值 |
|
amount |
String |
是 |
|
成功充值数量 |
余额充值:单位元 积分充值:积分数量 |
||
idType |
String |
是 |
|
会员账号类型 |
1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 6 会员编号 |
||
memberId |
String |
是 |
|
会员账号 |
会员动态码展示为:会员编号 |
||
consumeShopId |
Integer |
否 |
|
充值店铺Id |
|
||
consumeShopCode |
String |
否 |
|
充值店铺编号 |
|
||
consumeShopName |
String |
否 |
|
充值店铺名称 |
|
||
rechargeStatus |
Integer |
是 |
|
处理状态 |
0-待处理 1-处理成功 2-处理失败 3-审核拒绝 |
||
rechargeStatusDesc |
String |
是 |
|
处理状态描述 |
0-待处理 1-处理成功 2-处理失败 3-审核拒绝 |
||
failDesc |
String |
否 |
|
失败原因 |
|
||
remark |
String |
否 |
|
备注 |
|
||
rechargeTime |
String |
是 |
|
充值时间 |
时间格式:yyyy-dd-MM HH:mm:ss |
||
requestor |
String’ |
是 |
|
操作员(充值申请人) |
接口充值为:接口导入 |
||
auditor |
String |
是 |
|
充值审批人 |
请求示例
{"orderId ":"122212132323231231"}
响应示例
{
"code": "0",
"data": "[{"idType":"1","rechargeStatus":1,"auditor":"接口导入","rechargeTime":"2021-09-14 10:02:14","memberId":"13033333333,"requestor":"接口导入","reChargeType":0,"rechargeStatusDesc":"处理成功","amount":6.00}]",
"sign": "cS/NJZo1+eUyLdeFzeFj8ZpiZtYL6R+lbMuSqYGVPaAuikHIx71UGkq0KdOxKFYctBRTjFG9s85GGSf7oq1BjIsUYoVUC+9nNANfGgF1UpzRngkyD0PBboCiM0v0zvd4pP3ishKhprSXdupNfREUwYjWq5NLO9F9gWf7tXK/7sA="
}
3.1.21会员绑定实体卡(开卡)
method: allinpay.shopoint.memberService.activityMemberCard
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
mobile |
String |
是 |
|
手机号 |
|
memberCardNo |
String |
是 |
|
会员卡卡号 |
|
password |
String |
否 |
|
密码 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
code |
Integer |
是 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
错误信息 |
|
data |
Boolean |
是 |
true为绑卡成功 |
|
请求示例
{"mobile":"18621925650","memberCardNo":"7782822","password":"helloworld"}
响应示例
{
"code": 0,
"data": true
}
3.1.22会员卡密码修改
method: allinpay.shopoint.memberService.modifyMemberCardPassword
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
mobile |
String |
是 |
|
手机号 |
|
isCheckOldPassword |
Boolean |
是 |
|
是否校验原密码 |
true或false |
oldPassword |
String |
否 |
|
原密码 |
校验原密码时必填,加密传输(详见2.3.4) |
newPassword |
String |
是 |
|
新密码 |
加密传输(详见2.3.4) |
业务响应参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
code |
Integer |
是 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
错误信息 |
|
data |
Boolean |
是 |
true为改密成功 |
|
请求示例
{"mobile":"18621925650","memberCardNo":"7782822","isCheckOldPassword":true,"oldPassword":"helloworld","newPassword":"hiworld"}
响应示例
{
"code": 0,
"data": true
}
3.1.23会员调账
依据会员标识对会员积分及余额进行调账。
method: allinpay.shopoint.memberService.memberBalanceAdjust
version: 1.0
业务请求参数
字段名 |
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
orderId |
|
String |
是 |
|
外部调账订单号 |
|
adjustList |
|
List |
是 |
|
调账列表 |
|
idType |
String |
是 |
|
会员账号类型 |
1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 5- 外部会员ID 6 内部会员ID |
|
memberId |
String |
是 |
|
会员账号 |
|
|
adjustType |
String |
是 |
|
调账类型 |
1- 余额调账 2- 积分调账 |
|
amount |
String |
是 |
|
调账数量 |
余额调账:单位元 积分调账:积分数量 |
|
consumeShopId |
Integer |
否 |
|
调账店铺Id |
|
|
consumeShopCode |
String |
否 |
|
调账店铺编号 |
同时传consumeShopId和consumeShopCode时,consumeShopCode不生效 |
|
remark |
String |
否 |
255 |
备注 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
code |
Integer |
是 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
错误信息 |
|
data |
Boolean |
是 |
|
True |
请求示例
{“adjustList”:[{“idType":"1","memberId":"13882177104","adjustType":"1","amount":"10"}]}
响应示例
{
"code": 0,
"data": true,
"token": "QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs"
}
3.1.24会员调账查询
针对接口3.1.23的余额和积分的调账结果查询。
method: allinpay.shopoint.memberService.memberBalanceAdjustQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
orderId |
String |
是 |
60 |
外部调账订单号 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
否 |
|
错误信息 |
|
||
Data |
orderId |
String |
否 |
|
外部调账订单号 |
|
|
records |
List |
否 |
|
调账明细列表 |
|
||
|
adjustType |
Integer |
是 |
|
调账类型 |
1-余额调账 2-积分调账 |
|
amount |
String |
是 |
|
成功调账数量 |
余额调账:单位元 积分调账:积分数量 |
||
idType |
String |
是 |
|
会员账号类型 |
1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 6 会员编号 |
||
memberId |
String |
是 |
|
会员账号 |
会员动态码展示为:会员编号 |
||
consumeShopId |
Integer |
否 |
|
调账店铺Id |
|
||
consumeShopCode |
String |
否 |
|
调账店铺编号 |
|
||
consumeShopName |
String |
否 |
|
调账店铺名称 |
|
||
remark |
String |
否 |
|
备注 |
|
||
adjustStatus |
Integer |
是 |
|
处理状态 |
0-待处理 1-处理成功 2-处理失败 3-审核拒绝 |
||
adjustStatusDesc |
String |
是 |
|
处理状态描述 |
0-待处理 1-处理成功 2-处理失败 3-审核拒绝 |
||
failDesc |
String |
否 |
|
失败原因 |
|
||
adjustTime |
String |
是 |
|
充值时间 |
时间格式:yyyy-dd-MM HH:mm:ss |
||
requestor |
String’ |
是 |
|
操作员(调账申请人) |
接口调账为:接口导入 |
||
auditor |
String |
是 |
|
充值审批人 |
请求示例
{"orderId ":"122212132323231231"}
响应示例
{
"code": "0",
"data": "[{"idType":"1","adjustStatus":1,"auditor":"接口导入","adjustTime":"2021-09-14 10:02:14","memberId":"13033333333,"requestor":"接口导入","adjustType":0,"adjustStatusDesc":"处理成功","amount":6.00}]",
"sign": "cS/NJZo1+eUyLdeFzeFj8ZpiZtYL6R+lbMuSqYGVPaAuikHIx71UGkq0KdOxKFYctBRTjFG9s85GGSf7oq1BjIsUYoVUC+9nNANfGgF1UpzRngkyD0PBboCiM0v0zvd4pP3ishKhprSXdupNfREUwYjWq5NLO9F9gWf7tXK/7sA="
}
3.1.25会员状态变更
method: allinpay.shopoint.memberService.memberChangeStatus
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
idType |
String |
是 |
|
会员账号类型 |
1- 手机号 2- 会员卡号 3- openid 4- 会员动态码 6- 会员ID |
memberId |
String |
是 |
|
会员账号 |
|
newStatus |
Integer |
是 |
|
新状态 |
0:正常 1: 冻结 |
orderId |
String |
是 |
|
状态变更外部订单号 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
code |
Integer |
是 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
错误信息 |
|
data |
Boolean |
是 |
true为操作成功 |
|
请求示例
{"memberId":"18621925650","idType1,"newStatus":1}
响应示例
{
"code": 0,
"data": true
}
3.1.26发送短信验证码
method: allinpay.shopoint.memberService.sendSmsCode
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
mobile |
String |
是 |
|
手机号 |
|
smsCode |
String |
是 |
|
验证码 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
说明 |
取值 |
code |
Integer |
是 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
错误信息 |
|
data |
Boolean |
是 |
true为操作成功 |
|
请求示例
{"mobile":"18621921111","smsCode":"111111"}
响应示例
{
"code": 0,
"data": true
}
3.1.28会员消费查询
支持对会员消费(包括3.1.15会员无密码消费、3.1.27会员消费)的查询。
method: allinpay.shopoint.memberService.consumeQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
orderId |
String |
是 |
60 |
外部消费订单号 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
4 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
否 |
200 |
错误信息 |
|
||
data |
respId |
Integer |
是 |
9 |
平台处理编号 |
|
|
orderId |
String |
是 |
60 |
外部消费订单号 |
|
||
idType |
String |
否 |
1 |
会员账号类型 |
1- 手机号 2- 会员卡号 3- Openid 4- 会员动态码 6 会员编号 |
||
memberId |
String |
否 |
128 |
会员账号 |
会员动态码展示为会员编号 |
||
balance |
String |
否 |
16 |
消费余额 |
单位元,大于0,可保留小数点后2位 |
||
balanceRemark |
String |
否 |
255 |
消费余额备注 |
消费余额大于0时有效 |
||
balanceConsumeTime |
String |
否 |
14 |
消费余额时间 |
格式:yyyyMMddHHmmss |
||
scores |
String |
否 |
11 |
消费积分 |
正整数 |
||
scoreRemark |
String |
否 |
255 |
消费积分备注 |
消费积分大于0时有效 |
||
scoreConsumeTime |
String |
否 |
14 |
消费积分时间 |
格式:yyyyMMddHHmmss |
||
shopId |
String |
否 |
11 |
店铺Id |
|
||
shopCode |
String |
否 |
20 |
店铺编号 |
|
||
couponConsumeList |
List |
否 |
|
验券列表 |
|
||
|
couponNo |
String |
是 |
32 |
券号 |
|
|
consumeAmount |
String |
是 |
16 |
成功验券金额或数量 |
计次卡类单位为:次,现金卡单位:元 |
||
consumeTime |
String |
是 |
14 |
核券时间 |
格式:yyyyMMddHHmmss |
||
remark |
String |
否 |
255 |
备注 |
|
请求示例
{"orderId ":"122212132323231231"}
响应示例
3.1.29会员消费撤销
对会员消费(包括3.1.15会员无密码消费、3.1.27会员消费)进行撤销操作。
method: allinpay.shopoint.memberService.consumeCancel
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
reqOrderNo |
String |
是 |
60 |
原始订单号 |
|
|
refundOrderNo |
String |
是 |
60 |
退款订单号 |
|
|
refundBalance |
String |
否 |
16 |
撤销消费余额 |
单位:元 |
|
refundScores |
String |
否 |
11 |
撤销消费积分数量 |
积分数量 |
|
operUserId |
String |
否 |
30 |
收银员 |
收银员登录账号 |
|
couponConsumeList |
|
否 |
|
验券部分撤销列表(仅支持金额券) |
如果撤销余额、撤销积分和验券撤销列表均未填写,则撤销剩余的全部; 如果传了撤销余额、撤销积分或者验券撤销列表的一个或者多个,传了什么就撤销什么 |
|
|
couponNo |
String |
是 |
32 |
券号或券动态码 |
|
consumeAmount |
String |
是 |
16 |
金额券单位:元 |
|
|
remark |
String |
否 |
255 |
备注 |
|
|
stlmShopList |
List |
否 |
|
结算店铺信息 |
|
|
stlmShopId |
Integer |
否 |
|
结算店铺id |
|
|
stlmShopCode |
String |
否 |
|
结算店铺号 |
|
|
stlmAmount |
Decimal |
否 |
|
结算金额, 单位元 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
code |
Integer |
是 |
4 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
200 |
错误信息 |
|
请求示例
{“reqOrderNo”:”112121212121”}
响应示例
{
“code”: 0,
“data”: “”,
“token”: “QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs”
}
3.1.30会员消费撤销查询
针对3.1.29会员消费撤销的查询。
method: allinpay.shopoint.memberService.consumeCancelQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
refundOrderNo |
String |
是 |
60 |
外部消费撤销订单号 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
4 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
否 |
200 |
错误信息 |
|
||
data |
respId |
Integer |
是 |
9 |
平台处理编号 |
|
|
refundOrderNo |
String |
否 |
60 |
外部消费撤销订单号 |
|
||
refundBalance |
String |
否 |
16 |
撤销余额 |
单位:元 |
||
refundScores |
String |
否 |
11 |
撤销积分 |
积分数量 |
||
couponConsumeList |
List |
否 |
|
验券部分撤销列表(仅支持金额券) |
|
||
|
couponNo |
String |
是 |
32 |
券号 |
|
|
consumeAmount |
String |
是 |
16 |
成功撤销金额或数量 |
计次卡类单位为:次,现金卡单位:元 |
||
remark |
String |
否 |
255 |
备注 |
|
请求示例
{"refundOrderNo":"122212132323231231"}
响应示例
3.1.31会员无密码消费
使用某些特殊场景下,不经密码确认消费会员积分或余额或优惠券(计次券)。
method: allinpay.shopoint.memberService.passwordlessConsume
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
idType |
String |
是 |
1 |
会员账号类型 |
1- 手机号 2- 会员卡号 3- openid 4- 会员动态码 5- 外部会员ID |
|
memberId |
String |
是 |
180 |
会员账号 |
|
|
balance |
String |
否 |
16 |
消费余额 |
单位元,大于0,可保留小数点后2位 |
|
balanceRemark |
String |
否 |
255 |
消费余额备注 |
消费余额大于0时有效 |
|
scores |
String |
否 |
11 |
消费积分 |
正整数 |
|
scoreRemark |
String |
否 |
255 |
消费积分备注 |
消费积分大于0时有效 |
|
shopId |
String |
否 |
11 |
店铺ID |
|
|
shopCode |
String |
否 |
20 |
店铺号 |
与shopId功能相同,shopId和shopCode同时输入则只取shopId,shopId和shopCode必输一项 |
|
operUserId |
String |
是 |
30 |
收银员 |
收银员登录名称 |
|
orderId |
String |
是 |
60 |
外部消费订单号 |
|
|
couponConsumeList |
|
List |
否 |
|
验券列表 |
consumeType=3消费券时必输 |
couponNo |
String |
是 |
32 |
券号或券动态码 |
|
|
consumeAmount |
String |
是 |
16 |
核销次数 |
计次卡类单位为:次 |
|
passwd |
String |
否 |
128 |
密码 |
|
|
remark |
String |
否 |
255 |
备注 |
|
|
stlmShopList |
List |
否 |
|
结算店铺信息 |
|
|
stlmShopId |
Integer |
否 |
|
结算店铺id |
|
|
stlmShopCode |
String |
否 |
|
结算店铺号 |
|
|
stlmAmount |
Decimal |
否 |
|
结算金额, 单位元 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|||
code |
Integer |
是 |
4 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|||
msg |
String |
是 |
200 |
错误信息 |
|
|||
data |
tranNo |
String |
是 |
60 |
流水号 |
|
||
|
finApports |
数组 |
否 |
|
|
|
||
|
|
couponNo |
String |
|
32 |
|
|
|
|
|
apports |
数组 |
|
|
|
|
|
|
|
|
apportCode |
String |
否 |
20 |
财务分摊编号 |
|
|
|
|
apportName |
String |
否 |
20 |
分摊描述 |
|
|
|
|
amount |
BigDecimal |
否 |
16 |
分摊金额 |
|
|
|
|
priority |
Integer |
否 |
10 |
优先级 |
|
请求示例
{"idType":"1","memberId":"13882177104","scores":"1","shopId":"1"," operUserId ":"1"}
响应示例
{
"code": 0,
"data": {
"finApports": [
{
"couponNo": "1239328402892",
"apports": [
{
"apportCode": "CW235",
"apportName": "金额券固定分摊",
"priority": 1,
"amount": 23.00
}
]
}
]
},
"token": "QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs"
}
3.1.32会员消费
依据会员标识消费会员积分、会员余额。支持卡/券列表消费(计次券)。
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||||
idType |
String |
是 |
1 |
会员账号类型 |
1- 手机号 2- 会员卡号 4- 会员动态码 5- 外部会员ID |
||||
memberId |
String |
是 |
180 |
会员账号 |
|
||||
balance |
String |
否 |
16 |
消费余额 |
单位元,大于0,可保留小数点后2位 |
||||
balanceRemark |
String |
否 |
255 |
消费余额备注 |
消费余额大于0时有效 |
||||
scores |
String |
否 |
11 |
消费积分 |
正整数 |
||||
scoreRemark |
String |
否 |
11 |
消费积分备注 |
消费积分大于0时有效 |
||||
shopId |
String |
否 |
11 |
店铺ID |
|
||||
shopCode |
String |
否 |
20 |
店铺号 |
与shopId功能相同,shopId和shopCode同时输入则只取shopId,shopId和shopCode必输一项 |
||||
operUserId |
String |
是 |
30 |
收银员 |
收银员登录名称 |
||||
passwd |
String |
否 |
128 |
支付密码 |
手机号、会员卡消费时必输,加密传输(详见2.3.4) |
||||
orderId |
String |
是 |
60 |
外部消费订单号 |
|
||||
couponConsumeList |
List |
否 |
|
验券列表 |
|
||||
couponNo |
String |
是 |
32 |
券号或券动态码 |
|
||||
consumeAmount |
String |
是 |
13 |
核销次数 |
计次卡类单位为:次 |
||||
passwd |
String |
否 |
128 |
密码 |
|
||||
remark |
String |
否 |
255 |
备注 |
|
||||
stlmShopList |
List |
否 |
|
结算店铺信息 |
|
||||
stlmShopId |
Integer |
否 |
|
结算店铺id |
|
||||
stlmShopCode |
String |
否 |
|
结算店铺号 |
|
||||
stlmAmount |
Decimal |
否 |
|
结算金额, 单位元 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|||
code |
Integer |
是 |
4 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|||
msg |
String |
是 |
200 |
错误信息 |
|
|||
data |
respId |
Integer |
是 |
9 |
平台处理编号 |
|
||
|
finApports |
数组 |
否 |
|
|
|
||
|
|
couponNo |
String |
|
32 |
|
|
|
|
|
apports |
数组 |
|
|
|
|
|
|
|
|
apportCode |
String |
否 |
20 |
财务分摊编号 |
|
|
|
|
apportName |
String |
否 |
20 |
分摊描述 |
|
|
|
|
amount |
BigDecimal |
否 |
16 |
分摊金额 |
|
|
|
|
priority |
Integer |
否 |
10 |
优先级 |
|
请求示例
{"idType":"1","memberId":"13882177104","consumeType":"1","amount":"0.1","passwd":" 6E5C47F095BB6DC3308A89514A7206C8","shopId":"1"}
响应示例
{
"code": 0,
"data": {
"finApports": [
{
"couponNo": "1239328402892",
"apports": [
{
"apportCode": "CW235",
"apportName": "金额券固定分摊",
"priority": 1,
"amount": 23.00
}
]
}
]
},
"token": "QX1YbSPkNEbu5x1EDKzXDJtxy86sQnO6ExGe9nWs"
}
3.1.34会员信息更新
接口方法:
method: allinpay.shopoint.memberService.memberBasicUpdate
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
idType |
Integer |
是 |
|
会员账号类型 |
1-手机号,2-会员卡号,3-Openid,4-会员动态码,5-外部会员ID,6-内部会员ID |
memberId |
String |
是 |
|
需要修改的会员账号 |
|
mobile |
String |
否 |
|
修改后的手机号 |
|
tags |
String |
否 |
|
修改后的会员标签 |
逗号分隔 |
memberLevelId |
String |
否 |
|
修改后的会员等级 |
|
name |
String |
否 |
|
修改后的姓名 |
|
gender |
String |
否 |
|
修改后的性别 |
|
nickName |
String |
否 |
|
修改后的昵称 |
|
birthday |
String |
否 |
|
修改后的生日 |
yyyy-M-d |
carLicenseNo |
String |
否 |
|
修改后的车牌号 |
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
|
code |
Integer |
是 |
4 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
|
msg |
String |
是 |
200 |
错误信息 |
|
|
data |
orgId |
Integer |
是 |
|
机构id |
|
memberLevelId |
Integer |
否 |
|
修改后的会员等级ID |
|
|
name |
String |
否 |
|
修改后的姓名 |
|
|
gender |
String |
否 |
|
修改后的性别 |
|
|
nickName |
String |
否 |
|
修改后的昵称 |
|
|
birthday |
String |
否 |
|
修改后的生日 |
yyyy-M-d |
|
carLicenseNo |
String |
否 |
|
修改后的车牌号 |
|
请求示例
{
"idType": "1",
"memberId": "18097944999"
}
响应示例
{
"orgId": 100152,
"memberLevelId": "194"
}
3.1.35会员账户流水
接口方法:
method: allinpay.shopoint.memberService.memberAccountPageQuery
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
token |
String |
是 |
|
调用3.1.6 统一登录(scope=4)后获得的token。 |
|
pageNo |
Integer |
否 |
|
页码 |
不填默认1, 最小为1
|
accountType |
Integer |
是 |
|
账户类型 |
4-积分, 5-余额 |
changeTypeList |
List |
否 |
|
变更方式集合 |
accountType为4:23-后台会员充值,36-商城售券积分抵扣,37-商城兑换,38-积分消费,40-后台调账,42-接口核券,52-订单消费送积分,53-权益赠送(注册),54-权益赠送(完善资料),55-权益赠送(首单礼),58-接口会员积分充值,59-接口会员积分消费,62-导购直接核会员积分,65-会员生日送积分,67-在线充值送积分,68-POS充值送积分,69-直接核销券或会员余额送积分,72-接口会员积分调账,76-会员升降级送积分,77-会员推荐送积分,311-订单撤销交易,312-API接口撤销交易; accountType为5:21-POS充值,22-在线充值,23-后台会员充值,30-大众码牌订单核券,31-POS订单核券,32-商城消费,34-POS直接核券,40-后台调账,42-接口核券,56-接口会员余额充值,57-接口会员余额消费,61-导购直接核会员余额,71-接口会员余额调账,311-订单撤销交易,312-API接口撤销交易 |
operUser |
String |
否 |
|
操作人 |
|
shopName |
String |
否 |
|
门店名称 |
|
shopId |
Integer |
否 |
|
门店Id |
|
memberName |
String |
否 |
|
会员姓名 |
|
memberMobile |
String |
否 |
|
会员手机号 |
|
beginTime |
String |
否 |
|
开始时间 |
时间格式:yyyy-dd-MM HH:mm:ss |
endTime |
String |
否 |
|
结束时间 |
时间格式:yyyy-dd-MM HH:mm:ss |
orderCode |
String |
否 |
|
订单号 |
|
outCardNo |
String |
否 |
|
外部卡号 |
|
dimension |
Integer |
否 |
|
查询维度 |
1-会员归属,2-操作归属 |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
||
code |
Integer |
是 |
4 |
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
||
msg |
String |
是 |
200 |
错误信息 |
|
||
data |
total |
Integer |
否 |
|
总数 |
只在第1页中返回交易流水总条数 |
|
current |
Integer |
是 |
|
分页页码 |
|
||
size |
Integer |
是 |
|
分页大小 |
|
||
records |
List |
否 |
|
流水分页 |
|
||
|
accountTypeDesc |
String |
是 |
|
账户类型 |
|
|
recharge |
BigDecimal |
是 |
|
充值 |
单位:元/分 |
||
give |
BigDecimal |
是 |
|
赠送数量 |
单位:元/分 |
||
changeTime |
String |
否 |
|
变动时间 |
时间格式:yyyy-dd-MM HH:mm:ss |
||
changeTypeDesc |
String |
是 |
|
变动方式 |
见入参changeTypeList枚举描述 |
||
shopName |
String |
否 |
|
门店名称 |
|
||
outCardNo |
String |
否 |
|
外部卡号 |
|
||
memberName |
String |
否 |
|
会员姓名 |
|
||
memberMobile |
String |
否 |
|
会员手机号 |
|
||
memberNickName |
String |
否 |
|
会员昵称 |
|
||
orderCode |
String |
否 |
|
订单号 |
|
||
operUser |
String |
否 |
|
操作人 |
|
||
remark |
String |
否 |
|
备注 |
|
请求示例
{
"pageNo":1,
"accountType":5,
"beginTime":"2023-10-01 00:00:00",
"endTime":"2023-10-31 23:59:59",
"changeTypeList":[
21
],
"operUser":"hl导购",
"memberName":"姓名997",
"memberMobile":"13882177387",
"shopName":"星巴克光华店"
}
响应示例
{
"records":[
{
"accountType":会员余额,
"recharge":1,
"give":0,
"changeTime":"2023-10-17 16:25:10",
"changeTypeDesc":后台会员充值,
"outCardNo":"6221886510045797175",
"memberName":"姓名997",
"memberMobile":"13882177387",
"operUser":"hl导购",
"orderCode":"60907050341112017866"
}
],
"total":1,
"size":500,
"current":1,
"pages":1
}
3.1.36银行卡解绑
解绑会员绑定的某一张银行卡。
接口方法:
method: allinpay.shopoint.memberService.unbindBankCard
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
bankOrgId |
Integer |
是 |
11 |
银行机构ID |
|
agreeId |
String |
是 |
|
协议编号 |
签约返回的agreeId |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
|
错误信息 |
|
3.1.37 获取用户基本信息(OAuth2)
用户授权第三方获取用户基本信息。
用户授权入口:https://dms.shopoint.cn/wxmall/index.html#openapi/oauth2/authorize?appId={appid}&redirectUri={redirectUri}&responseType=code&scope=snsapi_mobile&state=STATE
注意:替换appid和redirectUri。通惠将会把请求重定向到指定的redirectUri,并在URL中携带code参数,如http://mydomain.com?myparam=myvalue&code=xxx。接下来,对接方使用标准接口(allinpay.shopoint.oauth2.userInfo)通过code获取用户的手机号等已授权信息。
接口方法:
method: allinpay.shopoint.oauth2.userInfo
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
code |
String |
是 |
50 |
获取用户基本信息所使用的code |
注意: 1.该code的有效期为5分钟,过期自动作废。 2.该code具有一次性特点,使用后自动作废。 3.该code仅能由对应的appId使用。 |
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
|
错误信息 |
|
data |
String |
否 |
|
用户授权的基本信息 |
JSON格式的字符串 |
3.1.38 获取基础营销授权链接
获取基础营销授权链接,在微信中访问获取基础营销的用户信息,获取成功后回调到指定url并带上用户信息(?appid=&openid=&sign=&state=&unionid=&userid=)
接口方法:
method: allinpay.shopoint.memberService.dsktAuthUrl
version: 1.0
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
redirectUrl |
String |
是 |
|
授权后的回调url |
|
state |
String |
是 |
|
|
|
业务响应参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
code |
Integer |
是 |
|
返回码 |
0:表示成功; 3:表示失败,具体失败原因参见msg字段; 其他:参见4.1 公共返回码 |
msg |
String |
是 |
|
错误信息 |
|
data |
String |
是 |
|
授权链接 |
|
3.3.1 H5页面调用绑定微信和手机号(GET)
该接口属于页面跳转,将公共参数与业务参数签名后发起跳转请求,绑定操作完成后,跳转redirectUrl
处理逻辑:手机号不存在,则创建对用用户+绑定公众号;手机号如果存在且未绑定公众号,则绑定;手机号如果存在且已绑定当前公众号,则不做绑定直接进入redirectUrl页面;手机号存在且已绑定非当前公众号,则绑定失败并提示错误信息;如果当前公众号的openid被其他手机号绑定了,则绑定失败并提示错误信息
method: allinpay.shopoint.memberService.bindWx
version: 1.0
测试环境地址: https://dms-test.shopoint.cn/wxmall/index.html#/BindWx
生产环境地址: https://dms.shopoint.cn/wxmall/index.html#/BindWx
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
mobile |
String |
是 |
|
手机号 |
加密传输(详见2.3.4) |
redirectUrl |
String |
是 |
|
跳转Url |
|
orgOpenId |
String |
否 |
|
对接方公众号openid |
加密传输(详见2.3.4) 传递该值后进入数字营销系统将不再重复获取 |
tags |
String |
否 |
|
标签组 |
多个”,”隔开 |
outCustomerLevel |
String |
否 |
|
外部会员等级 |
|
请求示例
{"mobile":"13240001001","redirectUrl":"https%3A%2F%2Fdms-test.shopoint.cn%2Fwxmall%2Findex.html%23%2Fbank%3ForgId%3D100152%26_c%3D1"}
生成链接示例:
3.3.2 H5页面调用绑定微信和外部顾客编号(GET)
该接口属于页面跳转,将公共参数与业务参数签名后发起跳转请求,绑定操作完成后,跳转redirectUrl
处理逻辑:外部顾客号不存在,则创建外部顾客+绑定公众号;外部顾客如果存在且未绑定公众号,则绑定;外部顾客如果存在且已绑定当前公众号,则不做绑定直接进入redirectUrl页面;外部顾客存在且已绑定非当前公众号,则绑定失败并提示错误信息;如果当前公众号的openid被其他顾客号绑定了,则绑定失败并提示错误信息
method: allinpay.shopoint.memberService.bindWx2
version: 1.0
测试环境地址: https://dms-test.shopoint.cn/wxmall/index.html#/BindWx2
生产环境地址: https://dms.shopoint.cn/wxmall/index.html#/BindWx2
业务请求参数
字段名 |
参数类型 |
必填 |
最大长度 |
说明 |
取值 |
customerCode |
String |
是 |
|
外部顾客编号 |
加密传输(详见2.3.4) |
redirectUrl |
String |
是 |
|
跳转Url |
|
tags |
String |
否 |
|
标签组 |
多个”,”隔开 |
请求示例
请求参数示例:
{"customerCode":"test240001001","redirectUrl":"https%3A%2F%2Fdms-test.shopoint.cn%2Fwxmall%2Findex.html%23%2Fbank%3ForgId%3D100152%26_c%3D1"}
生成链接示例:
https://dms-test.shopoint.cn/openapis/index.html#/BindWx2?appId=kYXpovEmoATl&bizContent=GSt3TKJbiLftGFTRAq6l8htRWsf83fGWBTsX5QsT8yPtw%2FA9ZV1ZwTP33PZt404C%2FoMBYvbl%2FPMTYE%2B2egoeC96HC7Py%2FwijyD4XsFz0Se3vhFQIbKNX5xI%2BSTF8CgCwj89Dm0VOHcwBU5uvw36OptNBQxJuTxwH2sUR5xUI2Rha5MFH6ZggKMdq3MZ8ItGp&charset=UTF-8&format=JSON&method=allinpay.shopoint.memberService.bindWx2&reqSeq=1816301036394602496&sign=MEUCIGDh5iWFJ7O5VE2ozZSWHZ7UmZbQ2mq59ACcqOw%2BFKbZAiEAqr7QqicodbbBv1DBZasU6IvQAH5lOHULxF7SsGyHWTU%3D&signType=SM2×tamp=2024-07-25%2010%3A34%3A46&token=BLj5dRvtMzt%2FrGouiOYd81DGZWPgDWuczHBmiasD%2BtwsMXRvfzB4XcZbUONlDU63gXrMrrZx8RF1Yv1KQbTKKwqpZ%2BO7ODXhPED%2FTF48rQeZ4xsS7cH9WHMRJUyTfrD5vUXfBM5RbQdJG3JjMpgoRIs%3D&version=1.0