实时提现受理接口
1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2018/1/8 |
新接口参数定义 |
黄月巧 |
V0.2 |
2019/05/05 |
增加代理密码,和相关错误码 |
陈宋东 |
V0.3 |
2021/12/27 |
支持国密 |
王晶 |
V0.4 |
2022/03/27 |
接入云计费 |
王晶 |
V0.5 |
2022/05/25 |
支持指定提现卡及提现到一般消费户(预计20220609上线) |
王晶 |
2.接口说明
(1)场景说明
1、待结算户到一般户/银行卡(实时)
(2)接口说明
1、实时提现交易(待结算账户到银行卡)-V3.0版本
3.请求地址
4.请求参数说明
4.1 公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(1,128) |
Y |
接口名称 固定值 ysepay.merchant.withdraw.d0.accept |
partner_id |
String(1,20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
proxy_password |
String(50) |
N |
代理密码,请加密传输 注:如果签名方式为RSA,则用DES加密,密钥partner_id用户号前8位,不足8位前补空; 如果签名方式为SM,则用SM加密 |
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.1 当前版本:3.1。3.1版本增加返回云计费信息 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号,生成规则前8位必须为交易日期,如20161012,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 |
merchant_usercode |
String(1,20) |
N |
商户号,1.当商户号为空时,默认将partner_id作为商户号2.如果提现的商户号和合作商户号不一致则需要检查机构信息,或通过发起方的代理密码,检查代理关系 |
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 |
订单备注 |
shopdate |
String(8,8) |
Y |
商户系统的交易发生日期格式yyyyMMdd 示例值:20180525 |
card_type |
String(1,1) |
N |
到账卡类型 1-提现卡,空默认为结算卡 |
bank_account_no |
String(1,32) |
N |
card_type为1提现卡时必填 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_merchant_withdraw_d0_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 |
TRADE_FAILURE示例值:附录9.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 |
参考收款方手续费 |
withheld_amount |
String |
N |
增值费 |
charge_remark |
String |
N |
增值费描述 |
6.服务器异步通知参数
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号 |
trade_status |
String(32) |
Y |
交易目前所处的状态。状态的值:TRADE_SUCCESS|DISHONOUR_SUCCESS 示例值:附录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.withdraw.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编码 |
withheld_amount |
String |
N |
增值费,请求版本号3.1才返回 |
charge_remark |
String |
N |
增值费描述 ,请求版本号3.1才返回 |
7.样例
7.1 sdk调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互
OnlineReqDataVo req = new OnlineReqDataVo();
String reqUrl = "https://commonapi.ysepay.com/gateway.do";
String privateKeyFilePath = "D:\\opensdk\\hyfz_test2.pfx";
String publicKeyFilePath = "D:\\opensdk\\businessgate.cer";
String privateKeyPassworde = "123456";
String notifyUrl = "http://api.test.ysepay.net/atinterface/receive_return.htm";
req.setNotifyUrl(notifyUrl);
req.setPartnerId("hyfz_test2");
req.setReqUrl(reqUrl);
req.setPrivateKeyFilePath(privateKeyFilePath);
req.setPrivateKeyPassword(privateKeyPassworde);
req.setYsPublicKeyFilePath(publicKeyFilePath);
Map<String, Object> bizContent = new HashMap<>();
bizContent.put("out_trade_no", "20211012175144035102000788376200");
bizContent.put("merchant_usercode", "hyfz_test2");
bizContent.put("currency", "CNY");
bizContent.put("total_amount", "0.04");
bizContent.put("subject", "提现了");
bizContent.put("shopdate", "20211012");
req.setParamData(bizContent);
String result = null;
try{
logger.info("实时提现(待结算账户到银行卡)调用sdk接口addScanMerc请求入参为:"+ JSONObject.toJSONString(req));
result = MercFundApi.withdrawD0(req);
}catch (Exception e){
logger.info("实时提现(待结算账户到银行卡)失败:"+ e.getMessage());
}
8.附录
8.1 业务错误码
错误码 |
错误描述 |
解决方案 |
ACQ.SYSTEM_ERROR |
系统错误 |
请调用查询接口查询订单状态 |
ACQ.BUSINESS_TIMEOUT_ERROR |
业务超时 |
请调用查询接口查询订单状态 |
ACQ.ORGNO_CHECK_FAILD |
代理商与商户的机构关系不匹配 |
检查请求参数,修改后重新发起请求 |
ACQ.PROXY_CHECK_FAILD |
代理关系检查失败 |
比如委托关系不存在, 代理密码不一致 |
ACQ.PROXY_CHECK_PARAM |
代理关系参数验证失败 |
比如代理密码解密失败,或者代理密码有值,但委托商户号无值 |
ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数,修改后重新发起请求 |
PARAM_ERROR |
参数错误 |
检查请求参数,修改后重新发起请求 |
REPEAT_ORDER |
订单重复 |
该笔订单已受理,请使用新订单号发起请求 |
RISK_ERROR |
风控检查异常 |
请检查风控是否有异常,然后再重新发起 |
ROUTE_ERROR |
路由失败 |
请联系客服或市场技术支持人员 |
ACCOUNT_ERROR |
账户扣款失败 |
请联系客服或市场技术支持人员 |
FEE_ERROR |
计费失败 |
请联系客服或市场技术支持人员 |
DEAL_ERROR |
处理失败 |
请重新发起提现受理请求 |
8.2 交易状态
枚举名称 |
枚举说明 |
TRADE_ACCEPT_SUCCESS |
受理成功 |
TRADE_SUCCESS |
交易成功 |
TRADE_FAILURE |
交易失败 |