单笔代付交易(银行卡)
1.修订记录
修订 | 日期 | 说明 | 作者 |
---|---|---|---|
V0.1 | 2016/11/29 | 新接口参数定义 | 陈宋东 |
V0.2 | 2017/1/16 | 修改bank_account_no参数说明,修改为“银行帐号,注:当bank_account_type为对公账户时,该属性字段长度可以为String(1,32)” | 陈宋东 |
V0.3 | 2017/4/17 | 修改域名为df.ysepay.com | 陈宋东 |
V0.4 | 2017/5/4 | 修改异步回执notify_type,从df.batch.normal.status.sync修改成ysepay.df.batch.notify | 陈宋东 |
V0.5 | 2017/5/8 | 修改扩展字段中cert_expire的格式,从yy-MM-dd修改成yyMMdd | 陈宋东 |
V0.6 | 2017/5/15 | out_trade_no增加参数说明“只能由大小写英文字母、数字、下划线及横杠组成” | 陈宋东 |
V0.7 | 2017/5/16 | extend_params扩展参数中的cert_no,修改描述,增加了支持01中国护照的证件类型 | 陈宋东 |
V0.8 | 2017/5/25 | extend_params扩展参数去掉,同时将普通和加急文档合并 | 陈亮 |
V0.6 | 2017/5/27 | bank_account_no从原来的String(15,19),修改成String(10,23) | 陈宋东 |
V0.7 | 2017/5/31 | 增加bank_telephone_no,银行预留手机号码字段 | 陈宋东 |
V0.8 | N | 2017/06/19 | 陈宋东 |
V0.9 | 2017/6/22 | 增加了1.付款方的银行卡类型“unit”和证件类型“19”,2.添加cert_no,cert_type,cert_expire等属性 | 黄月巧 |
V1.0 | 2017/8/28 | 新加参数shopdate | 黄月巧 |
V1.1 | 2017/9/18 | 公共参数新加proxy_password和merchant_usercode参数 | 黄月巧 |
V1.2 | 2017/10/20 | 新增异常类型ACQ.BUSINESS_TIMEOUT_ERROR(业务超时) | 陈宋东 |
V1.3 | 2018/06/07 | 新增三方手续费 | 郑明新 |
V1.4 | 2019/08/15 | bank_account_name从原来的String(100),修改成String(200) | 黄敏 |
V1.5 | 2020/11/30 | 修改关于ACQ.SYSTEM_ERROR的中文描述 | 汤吉齐 |
V1.6 | 2021/12/27 | 支持国密 | 王晶 |
V1.7 | 2023/4/11 | 新增bank_code行号入参 | 王晶 |
2.接口说明
(1)场景说明
1、把商户账户里的钱,代付到对应的银行卡
(2)接口说明
1、单笔代付交易(银行卡)
3.请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://df.ysepay.com/gateway.do |
4.请求参数说明
4.1公共请求参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
method | String(1,128) | Y | 接口名称 , 分为普通和加急接口,要素一致 普通:ysepay.df.single.normal.accept 加急:ysepay.df.single.quick.accept |
partner_id | String(1,20) | Y | 在银盛支付开设的服务商商户号,请联系客户经理提供 |
proxy_password | String(50) | N | 代理密码,加密传输 |
merchant_usercode | String(20) | N | 代付商户号(银盛支付生成并下发) |
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) | Y | 银盛支付服务器主动通知商户网站里指定的页面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 | 商户系统生成的订单号,生成规则前8位必须为交易日期,如20161012,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
shopdate | String(8,8) | Y | 商户系统的交易发生日期格式yyyyMMdd 示例值:20180525 |
business_code | String(1,10) | Y | 业务代码 ,请联系银盛客户经理获取。注意:业务代码非固定值,不同到账方式需要传不同的业务代码 |
currency | String(3,3) | Y | 默认CNY(人民币) |
total_amount | Number(10,2) | Y | 代付的总金额。单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。Number(10,2)指10位长度,2位精度 |
subject | String(1,500) | Y | 订单备注 |
bank_code | String(12) | N | 银行行号 |
bank_name | String(1,128) | Y | 银行名称,为了保证代付交易成功,银行名称最好具体到分行 |
bank_province | String(40) | N | 开户行所在省份 |
bank_city | String(1,40) | Y | 开户行所在城市 |
bank_account_no | String(10,23) | Y | 银行帐号,注:当bank_account_type为对公账户时,该属性字段长度可以为String(1,32) |
bank_account_name | String(1,200) | Y | 银行帐号用户名 |
bank_account_type | String(3,9) | Y | 收款方银行账户类型,此处必填corporate :对公账户;personal:对私账户 |
bank_card_type | String(3,6) | Y | 支持卡类型,此处必填debit:借记卡;credit:信用卡 unit:单位结算卡 |
bank_telephone_no | String(1,11) | N | 银行预留手机号码 |
cert_type | Number(2) | N | 收款方证件类型00:身份证,19:营业执照 , |
cert_no | String(50) | N | 收款方证件号码。如果签名方式为RSA,则用DES加密,密钥Src用户号前8位,不足8位前补空格;如果签名方式为SM,则用SM加密 |
cert_expire | String(8) | N | 收款方证件有效期,格式yyyyMMdd,长期有效的居民身份证可为空 |
sub_merchant | SubMerchantInfo | N | 二级商户信息, Json格式,暂包括merName、merShortName、merAddr、telephone、merNo、category,如果有值则二级商户信息都不能为空,如果没值则都不能有值 |
4.3 二级商户 sub_merchant
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
merName | String(50) | N | 二级商户名称,支持25个中文 |
merShortName | String(50) | N | 二级商户简称,支持25个中文 |
merAddr | String(200) | N | 二级商户地址,支持100个中文 |
telephone | String(13) | N | 固定电话/手机号码二选一 |
merNo | String(32) | N | 二级商户编号 |
category | String(20) | N | 类目,按附件内容输入类目编号 |
5.同步返回参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
sign | String | Y | 签名字符串,Base64编码 |
普通:ysepay_df_single_normal_accept_response 加急:ysepay_df_single_quick_accept_response | String | Y | 业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
code | String | Y | 响应代码 |
msg | String | Y | 响应代码描述 |
out_trade_no | String(1,32) | Y | 商户系统生成的订单号 |
trade_status | String(32) | Y | 交易目前所处的状态。受理成功状态的值: TRADE_ACCEPT_SUCCESS 示例值:8.2 |
trade_status_description | String(256) | N | 状态描述 |
total_amount | Number(10,2) | Y | 代付的总金额。单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。 |
account_date | String(1,10) | N | 会计日期:日账单格式为yyyyMMdd 示例值:20160413 |
trade_no | String(30) | N | 银盛支付交易流水号 |
fee | Number(10,2) | N | 参考总手续费,单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。 |
partner_fee | Number(10,2) | Y | 该笔订单的合作方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
payee_fee | Number(10,2) | Y | 该笔订单的收款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
payer_fee | Number(10,2) | Y | 该笔订单的付款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
6.异步通知参数说明
银盛支付对商户的请求数据处理完成后,会将处理的最终结果数据异步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
out_trade_no | String(1,32) | Y | 商户系统生成的订单号,只能由大小写英文字母、数字、下划线及横杠组成 |
trade_status | String(32) | Y | 交易目前所处的状态。示例值:8.2 |
trade_status_description | String(256) | N | 状态描述,当trade_status为TRADE_FAILURE|DISHONOUR_SUCCESS时,该字段是代付失败或退票原因描述。该参数最长为128个汉字。 |
total_amount | Number(10,2) | Y | 代付的总金额。单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。 |
account_date | String(1,10) | Y | 会计日期:日账单格式为yyyyMMdd 示例值:20160413 |
trade_no | String(30) | N | 银盛支付交易流水号 |
fee | Number(10,2) | N | 参考总手续费,单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。 |
partner_fee | Number(10,2) | Y | 该笔订单的合作方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
payee_fee | Number(10,2) | Y | 该笔订单的收款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
payer_fee | Number(10,2) | Y | 该笔订单的付款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
notify_type | String | Y | 通知类型 固定值:ysepay.df.single.notify |
notify_time | String(19) | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
sign_type | String | Y | 报文签名算法,交易请求时的签名类型RSA/SM |
sign | String | Y | 签名字符串,Base64编码 |
7.样例
7.1 sdk样例
银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复 杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互。
```java /*1、获取需要的参数/ //商户进件请求路径,建议配置在项目的配置文件里面 String reqUrl = "https://df.ysepay.com/gateway.do";
//私钥证书存放路径,建议配置在项目的配置文件里面 String privateKeyFilePath = "D:\openRSA\hyfz_test2.pfx";
//ys公钥证书存放地址 建议配置在项目的配置文件里面 String publicKeyFilePath = "D:\openRSA\businessgate.cer";
//私钥证书密钥,建议配置在项目的配置文件里面 String privateKeyPassworde = "123456";
//商户在银盛支付平台开设的用户号[商户号],接入时需要替换成自己的 String partnerId = "hyfz_test2";
String notifyUrl = "http://127.0.0.1"; /*2、组装需要的参数/ OnlineReqDataVo req = new OnlineReqDataVo(); //设置私钥证书路径 req.setPrivateKeyFilePath(privateKeyFilePath); //设置私钥密钥 req.setPrivateKeyPassword(privateKeyPassworde); //设置ys公钥证书路径 req.setYsPublicKeyFilePath(publicKeyFilePath); //设置请求路径 req.setReqUrl(reqUrl); req.setPartnerId(partnerId); req.setNotifyUrl(notifyUrl); Map
paramData = new LinkedHashMap<>(); //订单号 paramData.put("out_trade_no","20211013000001"); //商户日期 paramData.put("shopdate","20211013"); //业务代码 paramData.put("business_code","00120001"); //暂时只支持币种:CNY(人民币) paramData.put("currency","CNY"); //代付的总金额 paramData.put("total_amount",1); //订单说明 paramData.put("subject","代付"); //银行名称,为了保证代付交易成功,银行名称最好具体到分行 paramData.put("bank_name","中国银行深圳云城支行"); //开户行所在省份 paramData.put("bank_province","广东省"); //开户行所在城市 paramData.put("bank_city","深圳市"); //银行帐号,注:当bank_account_type为对公账户时,该属性字段长度可以为String(1,32) paramData.put("bank_account_no","6217582000036073179"); //银行帐号用户名 paramData.put("bank_account_name","王想"); //收款方银行账户类型,此处必填corporate :对公账户;personal:对私账户 paramData.put("bank_account_type","corporate"); //支持卡类型,此处必填debit:借记卡;credit:信用卡 unit:单位结算卡 paramData.put("bank_card_type","debit"); //银行预留手机号码 paramData.put("bank_telephone_no",""); //收款方证件类型00:身份证,19:营业执照 , paramData.put("cert_type",""); //收款方证件号码。如果签名方式为RSA,则用DES加密,密钥Src用户号前8位,不足8位前补空格; 如果签名方式为SM,则用SM加密 //可空,cert_type不空则不能为空 paramData.put("cert_no",""); //收款方证件有效期,格式yyyyMMdd,长期有效的居民身份证可为空 paramData.put("cert_expire",""); //=============二级商户信息, Json格式============ Map
subMerchantMap = new HashMap<>(); /*二级商户信息若有值必须要传值,传空时会报错/ //二级商户二级商户名称,支持25个中文 subMerchantMap.put("merName",null); //二级商户简称,支持25个中文 subMerchantMap.put("merShortName",null); //二级商户地址,支持100个中文 subMerchantMap.put("merAddr",null); //客户手机号 subMerchantMap.put("telephone",null); //二级商户编号 subMerchantMap.put("merNo",null); //类目,按附件内容输入类目编号 paramData.put("category",null); //二级商户json格式 paramData.put("sub_merchant",subMerchantMap);
//业务员参数 req.setParamData(paramData);
logger.info("单笔代付(银行卡)请求入参为:"+ JSONObject.toJSONString(req));
/**2、调用API的方法*/
String result = null;
try{
//普通
result = DfApi.singleNormalDf(req);
//加急
//result = DfApi.singleQuickDf(req);
JSONObject jsonObject = JSON.parseObject(result, Feature.OrderedField);
//根据返回结果处理自己的业务逻辑,result内容详见接口文档
}catch (Exception e){
logger.info("单笔代付(银行卡)失败:"+e.getCause().getMessage());
//根据自己要求处理代付失败的业务逻辑
}
```
8.附录
8.1 业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
ACQ.SYSTEM_ERROR | 系统错误 | 支付中该状态为未知状态,请勿当成失败状态处理,请等待支付通知或继续查询 |
ACQ.BUSINESS_TIMEOUT_ERROR | 业务超时 | 请调用查询接口查询订单状态 |
ACQ.INVALID_PARAMETER | 参数无效 | 检查请求参数,修改后重新发起请求 |
PARAM_ERROR | 参数错误 | 检查请求参数,修改后重新发起请求 |
REPEAT_ORDER | 订单重复 | 该笔订单已受理,请使用新订单号发起请求 |
RISK_ERROR | 风控检查异常 | 请检查风控是否有异常,然后再重新发起 |
ROUTE_ERROR | 路由失败 | 请联系客服或市场技术支持人员 |
ACCOUNT_ERROR | 账户扣款失败 | 请联系客服或市场技术支持人员 |
FEE_ERROR | 计费失败 | 请联系客服或市场技术支持人员 |
DEAL_ERROR | 处理失败 | 请重新发起代付受理请求 |
ACQ.SHOPDATE_VALID_FAILD | 商户日期获取失败 | 检查参数 |
ACQ.PROXY_CHECK_FAILD | 代理关系检查失败 | 比如委托关系不存在 |
ACQ.PROXY_CHECK_PARAM | 代理关系参数验证失败 | 代理密码解密失败,或者代理密码与委托商户号没有同时传或者同时不传 |
8.2 交易状态
枚举名称 | 枚举说明 |
---|---|
TRADE_ACCEPT_SUCCESS | 受理成功 |
TRADE_SUCCESS | 交易成功 |
TRADE_FAILURE | 交易失败 |
DISHONOUR_SUCCESS | 退票成功 |