快捷协议签约
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2023.12.22 | 初版 |
2、业务说明
（1）接口说明
一、 场景说明
用户签约成功后，通过该接口可以创建无卡快捷订单及明细登记 协议快捷支付流程：
1、协议签约接口签约；
2、协议签约后，会收到短信验证码，再调用协议签约确认接口进行确认；
3、协议签约确认完成后，调用创建无卡快捷订单及明细登记接口订单创建；
4、创建无卡快捷订单及明细登记后，会收到短信验证码，调用确认协议快捷支付短信接口进行确认支付；
5、如果没有收到协议快捷短信验证码，调用重新获取协议快捷支付短信接口再发送短信验证码进行确认支付；
请求主体类型：application/json
请求方式：POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/unify/basePay/quickProtocol/sign |
| 正式环境 | https://ysgate.ysepay.com/openapi/unify/basePay/quickProtocol/sign |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称，固定值：unify.basePay.quickProtocol.sign |
| 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数据明文字符串）
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| orderId | String(32) | Y | 订单号,商户系统生成的订单号，生成规则前8位必须为交易日期，如20180525，范围跨度支持包含当天在内的前后一天，且只能由大小写英文字母、数字、下划线及横杠组成 示例值：201805256843192280647118 |
| payeeMercId | String(20) | Y | 收款商户号 |
| payeeMercName | String(50) | N | 收款方银盛支付客户名 |
| payerBankName | String(50) | Y | 付款方银行姓名 |
| payerBankNo | String(32) | Y | 付款方银行账号 |
| payerBankMobile | String(11) | Y | 付款方银行绑定手机号码 |
| cardExprDate | String(8) | N | 有效日期,贷记卡必传 |
| cvvCode | String(32) | N | CVV码,贷记卡必传 |
| idNo | String(64) | Y | 证件号码 |
| userId | String(25) | Y | 唯一客户标识,商户旗下客户 |
| imei | String(25) | N | 手机串号 |
| actionScope | String(2) | Y | 支付作用范围,01：发起方 + 收款方 + 商户旗下客户 + 持卡人(四要素) , 默认；02：发起方 + 商户旗下客户 + 持卡人(四要素) |
| totalAmount | String(10) | N | 该笔订单的资金总额,单位：分。必须为正整数 |
| srcIP | String(16) | Y | 发起方IP |
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数据)
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| reqMsgId | String | Y | 请求流水号 |
| businessData | Object | N | 响应结果 |
5.2.1 businessData具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| tradeStatus | String | Y | 签约目前所处的状态,00-成功；10-处理中；50-超时；99-失败 |
| protocolNo | String | Y | 签约流水号 |
| orderId | String | Y | 订单号 |
| subMsg | String | N | 描述签约状态的具体信息 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 交易成功 | |
| 9999 | 系统错误 | 请根据返回提示操作或联系银盛技术人员处理 |
| 5000 | 请求超时 | 请检查网络或稍后重新发起请求 |
| A029998 | 网关非法参数 | 检查请求参数，修改后重新发起请求 |
| B020100 | 参数校验错误 | 检查请求参数，修改后重新发起请求 |
| B021100 | 前置系统参数验证错误 | 检查请求参数，修改后重新发起请求 |
| B023003 | 商户号错误 | 检查商户号数据。 |