接口地址
生产环境:https://cus.allinpay.com/cusapi/sybserviceapi/sendcoupons
测试环境:https://syb-test.allinpay.com/vsppcusapi/sybserviceapi/sendcoupons
使用场景:
一、使用自有appid发券:
1、在“商户服务平台-设置”中,配置收银宝对接参数;
2、根据运营提供的线下流程,申请创建微信券并获取相应的批次id
3、调用该api实现向指定用户发券
二、使用通联appid发券:
1、在“商户服务平台-设置”中,配置收银宝对接参数;
2、根据运营提供的线下流程,申请创建微信券并获取相应的批次id
3、在商户无指定appid情况下,通过收银宝发的交易结果中的 ”acct“或调用”H5获取微信OPENID“接口获取收银宝appid对应的openid
4、调用该api实现向指定用户发券
注意:
1、当前该接口只支持公众号发券,app不支持。
2、该类型券不支持插入卡包,如果需要插入卡包则自行开发微信卡包相关接口
请求参数:
参数 |
参数名称 |
取值 |
可空 |
长度 |
备注 |
orgid |
代理商号 |
平台分配的代理商号 |
否 |
15 |
|
cusid |
商户号 |
平台分配的商户号 |
否 |
15 |
|
appid |
应用ID |
平台分配的机构APPID |
否 |
8 |
|
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
randomstr |
随机字符串 |
商户自行生成的随机字符串 |
否 |
32 |
|
stockid |
代金券批次id |
示例值:9856000 |
否 |
20 |
微信为每个批次分配的唯一id |
openid |
用户openid |
示例值:2323dfsdf342342 |
否 |
128 |
openid信息,用户在appid下的唯一标识。 |
mchappid |
商户公众号appid |
示例值:wx233544546545989 |
否 |
128 |
微信为发券方商户分配的公众账号ID 接口传入的所有appid应该为公众号的appi (在mp.weixin.qq.com申请的) 不能为APP的appid(在open.weixin.qq.com申请的) |
couponvalue |
指定面额发券 面额 |
示例值:100 |
是 |
20 |
指定面额发券场景,券面额,其他场景不需要填 单位:分。 |
couponminimum |
指定面额发券 券门槛 |
示例值:100 |
是 |
20 |
指定面额发券批次门槛,其他场景不需要 单位:分 |
signtype |
签名类型 |
|
|
|
RSA/SM2 |
sign |
签名 |
详见安全规范 |
否 |
32 |
|
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
retcode |
返回码 |
SUCCESS/FAIL |
否 |
8 |
SUCCESS-请求成功 FAIL-请求或前端处理失败,具体看retmsg |
retmsg |
返回码说明 |
|
是 |
100 |
|
trxstatus |
状态码 |
1000 | 1001 |
是 |
4 |
1000: 获取结果成功 1999 :获取失败 |
以下信息只有当retcode为SUCCESS时有返回 |
|||||
status |
操作状态 |
00 /01 |
否 |
2 |
00:操作成功 01:操作失败 |
errmsg |
错误信息 |
|
是 |
100 |
|
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |