保存码牌信息

1、修订记录

修订记录 日期 说明
1.0 2022.04.14 初版

2、业务说明

(1)接口说明

1、当前接口是用来预生成指定数量的码牌,生成的码牌挂靠在指定代理商下面,码牌可以绑定到指定商户,也可以不绑定商户 2、返回批量生成的码牌编号信息(码牌编号、所属代理商、码牌二维码URL、激活状态信息)

请求主体类型:application/json

请求方式:POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay.com/openapi/saas_internal_api_gateway/1.0.0/qianhaiYiLian/saveCodeBoard
正式环境 https://ysgate.ysepay.com/openapi/saas_internal_api_gateway/1.0.0/qianhaiYiLian/saveCodeBoard

4、请求参数说明

4.1、公共请求参数

参数 类型(长度) 必填 参数说明
timeStamp String Y 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss"
method String(128) Y 接口名称,固定值:saas_internal_api_gateway.1.0.0.qianhaiYiLian.saveCodeBoard
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数据明文字符串)

参数 类型(长度) 必填 参数说明
agentNo String N 代理商编号
codeName String N 码牌名称
codeNum int N 码牌数量
merchantNo String N 商户编号
storeNo String N 门店编号

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数据)

参数 类型(长度) 必填 参数说明
currTime String N 请求时间
data Array N 码牌信息修改请求参数
stackTrace String N 系统内部错误详细信息
stackType String N 该字段暂不需处理

5.2.1 data具体参数

参数 类型(长度) 必填 参数说明
agentName String N 代理商名称
agentNo String N 代理商编号
batchNo String N 批次号
codeName String N 码牌名称
codeNo String N 码牌编号
codeUrl String N 码牌二维码url
deviceName String N 绑定的云喇叭编号
merchantName String N 所属商户名称
merchantNo String N 所属商户号
status String N 状态 0待激活1正常2停用,可用值:0,1,2
storeName String N 所属门店名称
storeNo String N 所属门店编号

6、业务响应码 网关公共响应码

响应码 响应码描述 解决方案
0 成功
101 操作失败 该错误都会返回具体的错误原因,请根据实际返回做相应处理
102 用户未登录 请登录
103 用户无权限 请联系银盛运营人员处理
104 认证失败 请根据具体返回错误处理
105 参数校验失败 检查请求参数,修改后重新发起请求
106 请求参数校验失败 检查请求参数,修改后重新发起请求
107 服务器错误 请稍后再试或联系银盛技术人员处理

113 限流异常
114 重复请求 检查请求参数,修改后重新发起请求
115 远程调用失败

results matching ""

    No results matching ""