新增微信优惠费率活动报名
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2022.10.20 | 初版 |
2、业务说明
(1)接口说明
调用该接口帮助已完成开户意愿确认的商户报名微信支付优惠费率活动。
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/weChatActivities/preferentialRates/addData |
正式环境 | https://ysgate.ysepay.com/openapi/weChatActivities/preferentialRates/addData |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:weChatActivities.preferentialRates.addData |
charset | String(10) | Y | 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8 |
sign | String | Y | 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名 |
check | String | Y | 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo |
bizContent | String | Y | 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent |
reqId | String | Y | 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602 |
certId | String | Y | 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号 |
version | String | Y | 调用的接口版本,固定为:1.0 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
mercId | String(20) | Y | 商户号 |
activityId | String(20) | Y | 活动ID,schoolcanteen_001:教育食堂行业活动,education_001:线下教培机构 |
creator | String(15) | Y | 操作者 |
supplementaryRemark | String(2000) | N | 补充说明,补充说明和补充图片要填都填,要不填都不填 |
supplementaryPicture | String(1000) | N | 补充图片,最多可上传5张照片,图片直接用“;”分割 图片上传说明:图片上传的内容均为图片 id(调用图片上传接口获取图片id),其格式:"213;123;123;123;123;" 且最多五张图片。 活动类型是 schoolcanteen_001 教育食堂行业活动 1.商户类型是 1 小微,提示报错"小微不能报名该类型" 2.商户类型是 0(企业商户)或 2(个体商户) 传学校资质证明、合作资质证明、优惠费率承诺函、用餐环境、门头照、补充照片(非必传项) 3.商户类型是 3(事业单位)或 4(社会组织)或 5(政府机关) 传学校资质证明、办学许可证、用餐环境、门头照、补充照片(非必传项) 活动类型是 education_001,线下教培机构 传机构资质证明、门店租赁证明、门头照、补充照片(非必传项) |
thirdMercIdCups | String(20) | N | 银联微信第三方商户号,联微信第三方商户号和网联微信第三方商户号不能都为空 |
thirdMercIdNucc | String(20) | N | 网联微信第三方商户号,银联微信第三方商户号和网联微信第三方商户号不能都为空 |
schoolPhoto | String(1000) | N | 学校资质证明,最多可上传5张照片,图片直接用“;”分割 |
cooperationPhoto | String(1000) | N | 合作资质证明,最多可上传5张照片,图片直接用“;”分割 |
perferentPhoto | String(1000) | N | 优惠费率承诺函,最多可上传5张照片,图片直接用“;”分割 |
restaurentEnvironmentPhoto | String(1000) | N | 食堂内部用餐环境照片,最多可上传5张照片,图片直接用“;”分割 |
restaurentFrontPhoto | String(1000) | N | 食堂门头照片,最多可上传5张照片,图片直接用“;”分割 |
teachingCommitmentPhoto | String(1000) | N | 办学许可证,最多可上传5张照片,图片直接用“;”分割 |
organizationPhoto | String(1000) | N | 机构资质证明,最多可上传5张照片,图片直接用“;”分割 |
rentmentCommitmentPhoto | String(1000) | N | 门店租赁相关证明,最多可上传5张照片,图片直接用“;”分割 |
frontPhoto | String(1000) | N | 门头照片,最多可上传5张照片,图片直接用“;”分割 |
5、响应参数说明
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
code | String(5) | Y | 网关响应码,示例值:00000 ,详见网关公共响应码 |
msg | String(50) | Y | 网关响应码描述 |
subCode | String | Y | 业务响应码,参见具体的API接口文档 |
subMsg | String | Y | 业务响应描述 |
timeStamp | String | Y | 响应时间,格式"yyyy-MM-dd HH:mm:ss" |
norce | String(128) | Y | 随机参数 |
sign | String | Y | 响应参数的签名串,详见demo, 注意:请用银盛公钥进行验签 |
businessData | String | Y | 业务响应参数集合, 注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
state | String | N | 交易状态 错误码成功时响应 |
reqMsgId | String | N | 请求流水号 |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
0000 | 成功 | |
9999 | 失败 | 系统异常,请稍后使用相同的参数继续调用 |
5000 | 超时 | 业务系统超时,请稍后使用相同的参数继续调用 |
A029998 | 参数非法 | 请根据接口返回的详细信息检查请求参数 |
B029992 | 新增失败 | 请根据接口返回的详细信息检查 |
B022011 | 发起方商户号和子商户号的归属关系校验失败(校验失败指校验不通 | 请确认商户号是否正确 |
B022012 | 最多可上传5张照片 | |
B022013 | 未找到图片id得路由 | 请上送正确的图片id |