单笔代付受理接口(平台内)
1.修订记录
修订 | 日期 | 说明 | 作者 |
---|---|---|---|
V0.1 | 2017/7/12 | 新接口参数定义 | 黄月巧 |
V0.2 | 2017/8/28 | 新加参数shopdate | 黄月巧 |
V0.3 | 2017/9/18 | 公共参数新加proxy_password和merchant_usercode参数 | 黄月巧 |
V0.4 | 2017/10/20 | 新增异常类型ACQ.BUSINESS_TIMEOUT_ERROR(业务超时) | 陈宋东 |
V0.5 | 2018/06/07 | 新增三方手续费 | 郑明新 |
V0.5 | 2020/11/30 | 修改关于ACQ.SYSTEM_ERROR的中文描述 | 汤吉齐 |
V0.6 | 2021/12/27 | 支持国密 | 王晶 |
2.接口说明
(1)场景说明
1、把商户账户里的钱,代付到对应的平台内商户
(2)接口说明
1、单笔代付受理接口-平台内
3.请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://df.ysepay.com/gateway.do |
4.请求参数说明
4.1公共请求参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
method | String(1,128) | Y | 接口名称 固定值 ysepay.df.single.quick.inner.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,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:2017071201124501 |
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 | 订单备注 |
payee_user_code | String(1,20) | Y | 收款方银盛商户号 |
payee_cust_name | String(1,50) | Y | 收款方银盛客户名 |
telephone_no | String(0,11) | N | 交易成功下发短信的号码 |
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_quick_inner_accept_respose | 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 | 参考合作方手续费 |
payee_fee | Number(10,2) | Y | 参考收款方手续费 |
payer_fee | Number(10,2) | Y | 参考付款方手续费 |
6.异步通知参数说明
银盛支付对商户的请求数据处理完成后,会将处理的最终结果数据异步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
out_trade_no | String(1,32) | Y | 商户系统生成的订单号 |
trade_status | String(32) | Y | 交易目前所处的状态。状态的值:TRADE_SUCCESS|TRADE_FAILURE 示例值: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 | 参考合作方手续费 |
payee_fee | Number(10,2) | Y | 参考收款方手续费 |
payer_fee | Number(10,2) | Y | 参考付款方手续费 |
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
//=============二级商户信息, Json格式============
Map
//业务参数 req.setParamData(paramData);
logger.info("单笔代付请求入参为:"+ JSONObject.toJSONString(req));
/3、调用API的方法*/ String result = null; try{ //FIXEDME 具体调用接口方法 result = DfApi.singleInnerDf(req); /4、处理响应参数*/ 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 | 交易失败 |