码牌列表查询
1、修订记录
修订记录 | 日期 | 说明 | 作者 |
---|---|---|---|
1.0 | 2022.1.5 | 初稿 | 康俊锋 |
2、业务说明
(1)接口说明
查询码牌列表
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/saas/org/queryBindQry |
正式环境 | https://ouser.ysepay.com:6443/saas/org/queryBindQry |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
ver | String(3) | Y | 版本号 固定值1.0 |
src | String(50) | Y | 由银盛生成的接入机构号,请联系银盛客户经理获取。示例值:ORG20210427160753 |
msgCode | String(20) | Y | 接口代码 固定值Merchant |
method | String(30) | Y | 接口方法 固定值必填queryBindQry |
signType | String(10) | Y | 报文签名算法,RSA、SM 注:应监管要求签名算法变更为国密,新接入商户请选择SM |
charset | String(10) | Y | 字符集 固定值UTF-8 |
reqFlowId | String(20) | Y | 请求流水号,示例值:202110011944011101 注意:该字段不参与签名 |
signValue | String | Y | 签名串,请参考”签名样例以及demo下载“。 |
data | String | Y | 业务参数(des加密成密文字符串) |
4.2、业务请求参数
data加密前的json数据明文字符串
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
mercId | String(20) | Y | 银盛商户号 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1、公共响应参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
ver | String(3) | Y | 版本号 固定值1.0 |
src | String(50) | Y | 由银盛生成的接入机构号,请联系银盛客户经理获取。示例值:ORG20210427160753 |
msgCode | String(20) | Y | 接口代码 固定值Merchant |
method | String(30) | Y | 接口方法 固定值queryBindQry |
signType | String(10) | Y | 报文签名算法,RSA、SM 注:应监管要求签名算法变更为国密,新接入商户请选择SM |
charset | String(10) | Y | 字符集 固定值UTF-8 |
reqFlowId | String(20) | Y | 请求流水号,示例值:202110011944011101 注意:该字段不参与签名 |
signValue | String | Y | 签名串,请参考”签名样例以及demo下载“。 |
data | String | Y | 业务参数(JSON数据) |
5.2、业务响应参数
data(JSON数据)
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
code | String(2) | Y | 返回码(00-成功;50-超时;99-失败) |
note | String(100) | Y | 返回码说明,返回信息描述 |
mercId | String(20) | N | 商户号,00-成功时返回 |
codeList | Object | N | 码牌列表,00-成功时返回 |
码牌列表对象(json 数据key: codeList)
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
codeId | String(20) | N | 码牌编号, 00-成功时返回 |
qrName | String(50) | N | 码牌名称, 00-成功时返回 |
status | String(2) | N | 码牌状态, 00 已激活、01 未激活、02 暂停,00-成功时返回 |
qrCodeUrl | String(50) | N | 码牌内容,00-成功时返回 |