终端报备
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2024.04.29 | 初版 |
2、业务说明
（1）接口说明
该接口是报备系统对外提供终端报备接口，可进行终端信息的报备，终端信息的修改，终端信息的注销
请求主体类型：application/json
请求方式：POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/report/scan/channel/terminalReport |
| 正式环境 | https://ysgate.ysepay.com/openapi/report/scan/channel/terminalReport |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称，固定值：report.scan.channel.terminalReport |
| 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数据明文字符串）
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| terminalInfoList | Array | Y | 终端列表 |
4.2.1 terminalInfoList具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String | Y | 商户号 |
| channelCode | String | Y | 渠道编号,商户交易场景包括微信、支付宝、云闪付，则需报备如下4个渠道： CUPS_WECHAT : 银联微信支付 CUPS_ALIPAY : 银联支付宝 CUPS_POS_SCANPAY : 银联云闪付 NUCC_WECHAT : 网联终端采集 |
| operationType | String | Y | 终端操作标识,00：新增 01：修改 （报备成功后，如需修改其他终端信息，则需调用修改接口） 02：注销 |
| terminalType | String | Y | 终端类型, 01 自动柜员机（含 ATM 和 CDM）和多媒体自助终端、 02 传统 POS 03 mPOS 04 智能 POS 05 II 型固定电话 06 云闪付终端 07 保留使用 08 手机 POS 09 刷脸付终端 10 条码支付受理终端 11 辅助受理终端 12 行业终端（公交、地铁用于指定行业的终端 13 MIS 终端 |
| terminalNo | String | N | 终端编号,当operationType=00且terminalType=11时终端编号可空，其他标识必填。 新增辅助受理终端时，建议终端编号送空，由平台统一生成并在响应参数中返回。 |
| serialNum | String | N | 终端序列号,按终端设备类型填写，当终端类型=02、03、04、05、06、08、09、10时，终端序列号必须填写； 这些设备类型监管组织会校验序列号正确性，不正确会报备失败 |
| terminalAddr | String | Y | 终端布放地址,省-市-区-详细地址，长度控制在 60 个字符，30 个汉字以内 例子：广东省-深圳市-光明区-长圳社区长兴工业城 |
| terminalReportState | String | N | 终端报备状态,为空默认为00 00：启用,99：注销 当operationType=01时，有效, 当operationType=00或02时， 此选项值无效 |
| terminalDevcMdl | String | N | 终端机具型号,终端厂商的终端机具类型编号 终端类型非07、11时必填 |
| terminalGpsFlg | String | N | 终端定位功能标识,终端类型非07、11时必填 00：可定位； 01：不可定位 |
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数据)
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| terminalInfoList | Array | N | 终端列表 |
| reqMsgId | String | N | 请求流水号 |
5.2.1 terminalInfoList具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String | N | 商户号 |
| channelCode | String | N | 渠道编号 |
| operationType | String | N | 终端操作标识,00：启用,99：注销 |
| terminalType | String | N | 终端类型 |
| terminalNo | String | N | 终端编号 |
| serialNum | String | N | 终端序列号 |
| terminalAddr | String | N | 终端布放地址 |
| terminalReportState | String | N | 终端报备状态,00成功,99 失败 |
| terminalDevcMdl | String | N | 终端机具型号 |
| terminalGpsFlg | String | N | 终端定位功能标识,00：可定位；01：不可定位 |
| note | String | N | 终端报备说明 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 成功 | |
| 9999 | 失败 | 系统异常，请稍后使用相同的参数继续调用 |
| 5000 | 超时 | 业务系统超时，请稍后使用相同的参数继续调用 |
| A029998 | 非法参数 | 请根据接口返回的详细信息检查请求参数 |