单笔代收协议签约
1.修订记录
修订 | 日期 | 说明 | 作者 |
---|---|---|---|
V0.1 | 2020/5/14 | 新接口参数定义 | 宁华雄 |
V0.2 | 2021/12/27 | 支持国密 | 王晶 |
2.接口说明
(1)场景说明
1、银联单笔代收,协议签约
(2)接口说明
1、单笔代收协议签约-V3.0版本
3.请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://ds.ysepay.com/gateway.do |
4.请求参数说明
4.1公共请求参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
method | String(1,128) | Y | 接口名称 固定值 ysepay.ds.protocol.sign.accept |
partner_id | String(1,20) | Y | 在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp | String(1,19) | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset | String(1,10) | Y | 商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type | String(1,10) | Y | 报文签名算法,RSA/SM |
sign | String(1,256) | Y | 签名字符串,再用Base64编码 |
notify_url | String(190) | N | 银盛支付服务器主动通知商户网站里指定的页面http路径。 |
version | String(1,3) | Y | 接口版本3.0 当前版本:3.0 |
biz_content | String | Y | 业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
out_trade_no | String(1,32) | Y | 商户系统生成的订单号 |
merchant_usercode | String(0,20) | N | 商户号,1.当商户号为空时,默认将partner_id作为商户号2.如果签约的商户号和合作商户号不一致则需要检查机构信息 |
shopdate | String(8,8) | Y | 商户系统的交易发生日期格式yyyyMMdd 示例值:20180525 |
currency | String(3,3) | Y | 默认CNY(人民币) |
mer_protocol_no | String(0,34) | Y | 付款客户和收款商户事先签订的收款协议,禁止中文 |
business_code | String(1,10) | Y | 业务代码 ,请联系银盛客户经理获取。注意:业务代码非固定值,不同到账方式需要传不同的业务代码 |
bank_name | String(1,128) | Y | 银行名称,为了保证交易成功,银行名称最好具体到分行 |
bank_account_no | String(10,32) | Y | 签约方银行卡号,注:当bank_account_type为对公账户时,该属性字段长度可以为String(1,32) |
bank_account_name | String(1,100) | Y | 签约方银行账户名称 |
bank_account_type | String(3,9) | Y | 签约方银行账户类型,此处必填corporate :对公账户(暂不支持);personal:对私账户 |
bank_card_type | String(3,6) | Y | 签约方支持卡类型,此处必填debit:借记卡;credit:信用卡 |
bank_telephone_no | String(1,11) | Y | 银行预留手机号码 |
cert_type | Number(2) | Y | 签约方证件类型,目前只支持身份证00 示例值:00 |
cert_no | String(1,44) | Y | 签约方证件号码注:如果签名方式为RSA,则用DES加密,密钥Src用户号前8位,不足8位前补空格;如果签名方式为SM,则用SM加密。 |
single_amount_limit_max | Number(10,2) | Y | 单笔代收支付交易最高金额 |
single_amount_limit_min | Number(10,2) | Y | 单笔代收支付交易最低金额 |
effect_date | String(19,19) | Y | 代收协议生效时间,请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
expire_date | String(19,19) | Y | 代收协议失效时间,请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
time_unit | String(2,2) | Y | 代收扣款时间单位 |
frequency | String(1,4) | Y | 代收扣款时间频率 |
5.同步返回参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
sign | String | Y | 签名字符串,Base64编码 |
ysepay_ds_protocol_sign_accept_respose | String | Y | 业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
code | String | Y | 响应代码 |
msg | String | Y | 响应代码描述 |
protocol_status | String(1,32) | Y | 协议状态, PROTOCOL_EFFECT;PROTOCOL_ACCEPT_SUCCESS;PROTOCOL_INVALID |
protocol_status_description | String(1,256) | Y | 协议状态说明PROTOCOL_EFFECT协议生效PROTOCOL_ACCEPT_SUCCESS;协议受理中PROTOCOL_INVALID协议无效 |
protocol_no | String(1,32) | Y | 银盛内部协议号 示例值:DS00004991 |
out_trade_no | String(1,32) | Y | 商户系统生成的订单号,只能由大小写英文字母、数字、下划线及横杠组成 |
shopdate | String(8,8) | Y | 商户系统的交易发生日期格式yyyyMMdd 示例值:20180525 |
6.样例
无
7.附录
7.1 业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
ACQ.SYSTEM_ERROR | 系统错误 | 请调用查询接口查询协议状态 |
ACQ.BUSINESS_TIMEOUT_ERROR | 业务超时 | 请调用查询接口查询订单状态 |
ACQ.SUB_SYS_CHECK_CUSTINFO | 该协议中存在空要素(手机号码,流水号,验证码),业务检查不通过 | 调用查询接口查询协议的信息,并联系银盛客服处理 |
ACQ.INVALID_PARAMETER | 无效的业务参数 | 找不到对应的客户信息,检查发起参数 |
ACQ.SUB_SYS_CHECK_TIME_LIM | 当前请求过于频繁,请稍后重试 | 每次获取授权码之后,需等待30秒后才能重新获取,还需等待30秒 |
ACQ.CONNECTIONT_ERROR | 连接子系统出错 | 请联系客服或市场技术支持人员 |
ACQ.SYSTEM_ERROR | 系统错误 | 请联系银盛客户或者市场技术支持 |
ACQ.PROTOCOL_EXISTED | 协议已经存在 | 协议已经存在不需要重新签订 |
ACQ.PROTOCOL_BUZICODE.ERROR | 代收协议不支持此业务代码 | 检查业务代码或者联系银盛客服 |
7.2 业务状态
枚举名称 | 枚举说明 |
---|---|
PROTOCOL_ACCEPT_SUCCESS | 签约请求受理成功,正在审核(未生效) |
PROTOCOL_EFFECT | 生效 |
PROTOCOL_INVALID | 无效(失效或者签约失败) |
SIGN_REPEAT | 重复签约,已存在相同维度的签约。可以从返回参数protocol_no中获取首次同维度的签约协议号 |
7.3 证件类型
证件类型 | 证件名称 |
---|---|
00 | 公民身份证 |
01 | 中国护照 |
03 | 警官证 |
04 | 户口簿 |
05 | 临时身份证 |
06 | 外国护照 |
07 | 港澳通行证 |
08 | 台胞通行证 |
14 | 军官证 |
17 | 武警士兵证 |
19 | 营业执照 |
20 | 税务登记证 |
24 | 外国人居留证 |
25 | 组织机构代码证 |
7.4 业务种类
业务代码 | 描述 |
---|---|
0060002 | 社保费 |
1010004 | 信息服务费 |
00120001 | GPS导航服务 |
00140001 | 还贷托收 |
00140002 | 手机流量费托收 |
00120002 | 赛格GPS导航服务 |
00500000 | 机票 |
00500001 | 电影票 |
00500002 | 彩票 |
01000015 | 代收货款 |
01000017 | 代收费用 |
01000014 | 物业管理费 |
01000005 | 网银充值 |
05000001 | 测试订单代码 |
1010015 | 小贷消金(代收专户) |
3010018 | 电子商务(订单支付专户) |
11010004 | 信息服务费1 |
31000010 | 网上购物1 |
5010001 | 线下代收业务(代收专户) |
5010003 | 线下订单支付(订单支付专户) |
1010001 | 社保费(代收专户) |
1010002 | 信息服务费(代收专户) |
1010003 | GPS导航服务费(代收专户) |
1010014 | 还贷托收(代收专户) |
1010005 | 手机流量费托收(代收专户) |
1010006 | 赛格GPS导航服务(代收专户) |
1010007 | 通讯费(代收专户) |
1010008 | 代收货款(代收专户) |
1010009 | 代收费用(代收专户) |
1010010 | 物业管理费(代收专户) |
1010011 | 消费分期(代收专户) |
1010012 | 融资租赁(代收专户) |
1010013 | 便民服务(水电煤)(代收专户) |
3010001 | 直接消费(订单支付专户) |
3010002 | 网上购物(订单支付专户) |
3010003 | 宜停车(订单支付专户) |
3010004 | 网银充值(订单支付专户) |
3010005 | 用户充值(订单支付专户) |
3010006 | 企业在线充值(订单支付专户) |
3010007 | 机票(订单支付专户) |
3010008 | 电影票(订单支付专户) |
3010009 | 投资理财(订单支付专户) |
3010010 | 增值业务(订单支付专户) |
3010011 | 综合商城(订单支付专户) |
3010012 | 游戏充值(订单支付专户) |
3010013 | 会员服务(订单支付专户) |
3010014 | 医疗服务(订单支付专户) |
3010015 | 众筹行业(订单支付专户) |
3010016 | 金融行业(订单支付专户) |
3010017 | 网络直播平台(订单支付专户) |
3010021 | 小贷消金(订单支付专户) |
00050008 | 手机话费 |
00490008 | 流量充值 |
01000016 | 理财POS |
00050000 | 通讯费 |
01010003 | 网银清算 |
00490006 | 消费返积分 |
00490004 | 消费 |
00050009 | 话费充值 |
00490005 | 信用卡还款 |
01000004 | 直接消费 |
01000010 | 网上购物 |
01000012 | 深圳路边临时停车充值 |
01000013 | 投资理财 |
00490007 | 宜停车充值 |
00050010 | Q币充值 |
01020003 | 跨境业务-网银 |
00050011 | 用户充值 |
01000024 | 银盛快付 |
00510026 | 线上订单通用二维码 |
00510030 | 扫码2.0 |
00510031 | 乐扫精灵反扫 |
00510033 | 保险 |
00510034 | 银盛E付 |
00510035 | 银联碰一碰支付 |
00510038 | D0暂缓后清算 |
01888888 | 正和天下 |
00490011 | 银盛通充值 |
06000020 | 商户个人网银在线还款 |
06000021 | 商户企业网银在线还款 |
2050009 | 扫码预授权 |
2050010 | 聚合扫码支付 |
00510024 | MPOS-SDK消费提现 |
01000022 | 企业快递 |
01000023 | 个人用户在线充值 |
00510025 | MPOS-SDK消费 |
00510027 | 银联云闪付合作伙伴开放平台 |
00510028 | 立牌 |
00510029 | 立牌快付 |
00510036 | 银盛E付线下 |
00510037 | 银盛E付提现 |
01020001 | 跨境业务(代收付)-商户计费) |
01020002 | 跨境业务(代收付)-持卡人收费) |
00490010 | 计次卡 |
01000020 | 个人在线充值 |
01000021 | 企业在线充值 |
00590004 | 微信 |
00690004 | 支付宝 |
00510023 | 扫码快付 |
00510032 | 线上订单快付 |
00510039 | SDK项目 |
00510040 | 小额手机POS |
7.5 代收频率说明
枚举名称 | 枚举值 |
---|---|
年 | 01 |
季度 | 02 |
月 | 03 |
周 | 04 |
日 | 05 |
说明:“代收协议扣款时间单位”和“代收扣款频率”确定扣款周期;
如:
按季度扣款时,扣款时间单位为“02”(季度),频率是1,每季度1次;
按月扣款时,扣款时间单位“03”(月),频率是3,每月3次;
按周扣款时,扣款时间单位为“04”(周),频率是1,每周1次;
每日扣款时,扣款时间单位为“05”(日),频率是2,每日2次;