快捷协议签约接口
1.修订记录
| 版本 |
日期 |
说明 |
作者 |
| V0.1 |
2025/06/06 |
新接口参数定义 |
谢虹 |
2.业务说明
(1)场景说明
发起前台签约,获取拉起银行或两联的签约页面参数(channel_url 和 request_param_map),在银行或两联的签约页面上,完成账户签约。
签约结果通过后台通知获取
(2)接口说明
- 签约登记并获取拉起签约页面的参数
3.请求地址
4.参数说明
4.1公共请求参数
| 参数 |
类型(长度) |
Y |
参数说明 |
| method |
String(128) |
Y |
接口名称 固定值 ysepay.online.fastpay.foreground.sign |
| partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
| timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
| charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
| sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
| sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
| notify_url |
String(500) |
Y |
签约结果及解约,后台回调地址,最大长度500 |
| return_url |
String(500) |
N |
签约结果,从银行页面跳转至商户页面 |
| version |
String(3) |
Y |
接口版本3.0 当前版本 3.0 |
| biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
| 参数 |
类型(字节长度) |
必填 |
参数说明 |
| out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
| seller_id |
String(1,20) |
Y |
收款商户号(银盛支付生成并下发) |
| seller_name |
String(1,50) |
N |
收款方银盛支付客户名(建议填写) |
| buyer_card_number |
String(1,32) |
Y |
付款方银行账号,请加密传输,签名方式为SM。 |
| user_id |
String(50) |
Y |
唯一客户标识,商户旗下客户号 |
| imei |
String(25) |
N |
手机串号 |
| actionScope |
String(2) |
N |
支付作用范围01:发起方 + 收款方 + 商户旗下客户 + 持卡人(四要素) , 默认02:发起方 + 商户旗下客户 + 持卡人(四要素) |
5.响应参数说明
商户发起签约登记,银盛检查商户发起的签约登记参数无误后,会返回拉起银行签约页面的必要参数,供商户拉起签约页面并使客户在银行页面完成签约。
签约结果通过后台通知发送给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 |
类型(字节长度) |
必填 |
参数说明 |
| sign |
String |
Y |
签名字符串,Base64编码 |
| ysepay_online_fastpay_foreground_sign_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
| 参数 |
类型(字节长度) |
必填 |
参数说明 |
| code |
String |
Y |
响应代码 |
| msg |
String |
Y |
响应代码描述 |
| out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号 |
| protocol_no |
String(20) |
N |
银盛支付平台的签约流水号 示例值:K2025060610340258645 ,签约登记成功状态下,必须返回 |
| trade_status |
String(30) |
Y |
签约目前所处的状态。PROCESSING:签约登记成功,请拉起签约页面完成签约;FAILED:签约登记失败;其他:签约登记失败 |
| sub_msg |
String(50) |
N |
返回信息 |
| channel_url |
String(50) |
N |
trade_status 为 PROCESSING时返回,银行签约页面url |
| request_param_map |
String(1000) |
N |
trade_status 为 PROCESSING时返回,拉起银行签约页面参数,JSON格式,页面表单POST提交 参数 |
5.3 签约结果响应参数
| 参数 |
类型(字节长度) |
必填 |
参数说明 |
| notify_type |
String |
Y |
通知类型,固定值:directpay.status.sync |
| notify_time |
String |
Y |
通知发起时间,yyyy-MM-dd HH:mm:ss |
| trade_status |
String(32) |
Y |
签约结果,SUCCESS:成功 ;FAILED:失败;其他状态码:失败 |
| protocol_no |
String(20) |
Y |
银盛支付平台的签约流水号 示例值:K2025060610340258645 |
| sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
| sign_date |
String(8) |
Y |
报文签名日期yyyyMMdd |
| sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
7.附录
7.1 签约错误码
| 错误码 |
错误描述 |
解决方案 |
| ACQ.SYSTEM_ERROR |
接口返回错误 |
该笔签约订单异常 |
| ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数,修改后重新发起请求 |
| ACQ.ACCESS_FORBIDDEN |
无权限使用接口 |
联系银盛市场人员进行签约 |
7.2 交易状态
| 枚举名称 |
枚举说明 |
| SUCCESS |
签约成功 |
| WAIT_CONFIRM |
签约登记成功(需要再次调用签约确认) |
| FAILED |
签约失败 |