查询协议
1. 接口介绍
功能简述：
本接口用于商户根据签约协议号查询签约信息。
约束条件：
无
正常流程：
1、 报文合性校验
2、 报文参数校验
3、 根据签约协议号查询签约信息
4、 返回签约信息
异常流程:
1、 请求源IP不在IP白单中
2、 报文验签失败
3、 报文参数非法
4、 签约协议号不存在
2. 请求地址
测试环境URL：
https://cmbchinab2b.bas.cmburl.cn/CmbBank_B2B/UI/NetPay/DoBusiness.ashx
生产环境URL：
https://b2b.cmbchina.com/CmbBank_B2B/UI/NetPay/DoBusiness.ashx
3. 请求报文
| 请求报文参数 | 类型（长度） | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| charset | String(8) | M | 编码格式，固定为UTF-8 | UTF-8 |
| jsonRequestData | String | M | json格式的请求参数，详见jsonRequestData定义 |
jsonRequestData参数定义
| 参数名 | 类型（长度） | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | String(3) | M | 固定为1.0 | 1.0 |
| sign | String | M | 使用商户支付密钥对reqData内的数据进行签名 | |
| signType | String | M | 固定为SHA-256 | SHA-256 |
| reqData | 请求数据 | |||
| dateTime | String（14） | M | 请求时间，商户发起该请求的时间，精确到秒。 格式： yyyyMMddHHmmss | 20160623101430 |
| txCode | String | M | 交易码，固定为CMCX | CMCX |
| branchNo | String(4) | M | 商户分行号，4位数字 | 0755 |
| merchantNo | String(6) | M | 商户号，6位数字 | 002346 |
| agrNo | String(32) | M | 客户签约的协议号 | 201606238888888 |
| merchantSerialNo | String（32） | M | 商户做此查询请求的流水号 | 2016062310143088 |
请求示例：
json报文组织：
{
"version":"1.0",
"sign":"见签名处理章节",
"signType":"SHA-256",
"reqData":{
"dateTime":"20160623101430",
"txCode":"CMCX",
"branchNo":"0755",
"merchantNo":"002346",
"merchantSerialNo":"2016062310143088",
"agrNo":"201606238888888"
}
}表单组织：
<form action="请求地址" method="post" > <input type="hidden" name="jsonRequestData" value='以上json字符串' /> <input type="hidden" name="charset" value='UTF-8' /> </form>
待签名字符串(未包含支付密钥)：
agrNo=201606238888888&branchNo=0755&dateTime=20160623101430&merchantNo=002346&merchantSerialNo=2016062310143088&txCode=CMCX
4. 响应报文
| 参数 | 类型（长度） | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | String(3) | M | 接口版本，固定为1.0 | 1.0 |
| charset | String(8) | M | 参数编码,固定为UTF-8 | UTF-8 |
| sign | String | M | 报文签名,使用商户支付密钥对rspData内的数据进行验签 | |
| signType | String | M | 签名算法，固定为SHA-256 | SHA-256 |
| rspData | 应答数据 | |||
| rspCode | String | M | 处理结果返回码，SUC0000：请求处理成功其他：请求处理失败 | SUC0000 |
| rspMsg | String | M | 处理结果返回码的描述信息 | 查询成功 |
| dateTime | String（14） | M | 响应时间，商户发起该请求的时间，精确到秒。 格式： yyyyMMddHHmmss | 20160623101430 |
| merchantSerialNo | String（32） | M | 商户流水号，原样返回商户做请求时的流水号 | 2016062310143088 |
| agrNo | String(32) | M | 客户签约的协议号 | 201606238888888 |
| userSignDateTime | String（14） | M | 客户签订协议的时间yyyyMMddHHmmss协议存在，才返回此字段 | 20160623101432 |
| userPidType | String（1） | M | 证件类型 目前只有 1，表示身份证协议存在，才返回此字段 | 1 |
| userPidHash | String（30） | M | 证件号映射的30位hash值 协议存在，才返回此字段 | 501010131010181016101010101012 |
| noPwdPay | String（1） | M | 免密标识，Y表示开通免密支付N表示不开通免密支付。协议存在，才返回此字段 | N |
| periodType | String（1） | M | 周期类型：D 按天M 按月N 按自然月 | D |
| periodMaxAmt | String（20） | M | 每期最大扣款金额，单位为分 | 1000 |
| period | String（4） | M | 周期间隔 | 1 |
| executeTime | String（8） | M | 周期开始时间（yyyyMMdd或yyyyMM） | 20210420或202104 |
| periodTotalCnt | String（4） | O | 周期总期数 | 12 |
| periodTotalAmt | String（20） | O | 周期总金额（分）： 为预留字段，默认返回空 | |
| expDate | String（8） | M | 协议过期时间 | 20221011 |
| billType | String（4） | M | 代收款项 | 22 |
| 以下字段联系招行配置控制参数后返回（默认不返回）： | ||||
| uniqueUserID | String(30) | C | 支付用户ID，由身份证+姓名生成（推荐使用） | UQwanCunLbp6cl1RbDFODrhLrAa48= |
| expandUserID | String(30) | C | 一网通用户ID，由一网通ID生成（招行一网通用户的身份标识） | EUfirwdVQVKhffJmjQhMod0dS6GYY= |
响应示例：
正常json报文组织:
{
"version":"1.0",
"charset":"UTF-8",
"sign":"见签名处理章节",
"signType":"SHA-256",
"rspData":{
"rspCode":"SUC0000",
"rspMsg":"查询成功。",
"dateTime":"20160623101430",
"merchantSerialNo":"2016062310143088",
"agrNo":"201606238888888",
"userSignDateTime":"20160623101432",
"userPidType":"1",
"userPidHash":"501010131010181016101010101012",
"noPwdPay":"N"
"expandUserID":" UQwanCunLbp6cl1RbDFODrhLrAa48=",
"uniqueUserID":"EUfirwdVQVKhffJmjQhMod0dS6GYY=",
"periodType":"M",
"periodMaxAmt":"1000",
"period":"1",
"executeTime":"20211011",
"periodTotalCnt":"12",
"periodTotalAmt":"",
"expDate":"20221011",
"billType":"22"
}
}待验签字符串(未包含支付密钥)：
agrNo=201606238888888&dateTime=20160623101430&merchantSerialNo=2016062310143088&noPwdPay=N&rspCode=SUC0000&rspMsg=查询成功&userPidHash=501010131010181016101010101012&userPidType=1&userSignDateTime=20160623101432
异常json报文组织:
{
"version":"1.0",
"charset":"UTF-8",
"sign":"见签名处理章节",
"signType":"SHA-256",
"rspData":{
"rspCode":"DCB0003",
"rspMsg":"DCB0003 请求报文JSON格式错误!",
"txCode":"",
"dateTime":"20160817141216"
}
}待验签字符串(未包含支付密钥)：
dateTime=20160817141537&rspCode=DCB0003&rspMsg=DCB0003 请求报文JSON格式错误!&txCode=
5. 错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
CMBMB33 | 客户协议不存在 | 调用签约接口，重新发起签约 |
CMBMB45 | 协议已注销 | 使用该协议号，调用签约接口，重新发起签约 |
CMBMB97 | 请求参数错误 | 根据提示信息中括号里的内容，修改请求参数。 如：请求参数错误(商户交易日期), 检查”商户交易日期”字段的内容是否正确 |
DCB0001 | DCB0001 贵方发送错误报文数 太多，已被限制访问！ | 异常操作错误太多，请根据之前的错误反馈 进行更改，限制将在一定时间后自动解除 |
DCB0002 | DCB0002 请求报文数据不能为空！ | 输入参数jsonRequestData拼写正确，并且值非空 |
DCB0003 | DCB0003 请求报文JSON格式错误! | 输入参数jsonRequestData为合法的JSON格式 |
DCB0004 | DCB0004 请求报文数据有误； 请求报文长度过长 | 缩短输入参数jsonRequestData内容 |
DCB0004 | DCB0004 请求报文数据有误：…… | 错误消息有以下这些情况，请根据对应提示修改。 接口版本号version值不正确 参数编码charset值不正确 签名sign不能为空 签名算法signType值不正确 请求数据reqData不能为空 时间戳dateTime位数超长或者为0 时间戳dateTime不能为空 交易功能码txCode位数超长或者为0 交易功能码txCode不能为空 商户号merchantNo位数超长或者为0 商户号merchantNo不能为空 分行号branchNo位数超长或者为0 分行号branchNo不能为空 商户流水号merchantSerialNo位数超长或者为0 商户流水号merchantSerialNo不能为空 客户协议号agrNo位数超长或者为0 客户协议号agrNo不能为空 |
DCB0005 | DCB0005 商户未开通接入平台功能； 商户号：…… | 商户号需要开通接入平台功能 |
DCB0006 | DCB0006 源IP地址不在商户IP白名单中； 商户号：…；IP地址：… | 商户需要提供IP添加到白名单中 |
DCB0007 | DCB0007 调用功能不可用； 调用功能代码：…… | 调用的功能不支持，请输入支持的功能代码 |
DCB0008 | DCB0008 签名验证失败：…… | 错误消息有以下情况，请根据对应提示修改。 签名时间戳格式不正确！ 签名时间错误，签名已经失效。 验签异常：…… |
DCB0010 | DCB0010 获取商户密钥失败；商户号：…… | 商户未正确开通接入平台功能，请按正规流程进行登记开通 |
DCB0017 | DCB0017 与业务系统的通讯失败：…… | 错误消息有以下情况，请稍后再试 [MIDServerComNP]业务系统繁忙 [MIDServerComNP]连接业务服务器失败：… [MIDServerComNP]接收业务系统通讯报文头失败 [MIDServerComNP]接收业务系统通讯报文头非法 [MIDServerComNP]接收业务系统通讯报文包体长度不正确.[…] [MIDServerComNP]与业务系统通讯异常：… |
DCB0018 | DCB0018 与业务系统的通讯异常：…… | 错误消息有以下情况，请联系招行相关技术支持人员。 解析中间业务平台返回报文失败 |
DCB0019 | DCB0019 企业网银签名异常：…… | 请联系招行相关技术支持人员 |
DCB0020 | DCB0020 服务器繁忙，请稍后再试。 | 当前服务器负载达到上限，请稍后再试。 |
DCB0021 | DCB0021 解析返回报文失败 | 请联系招行相关技术支持人员 |
6. FAQ
无
