实时提现交易(一般户)

1.修订记录

修订 日期 说明 作者
V0.1 2016/11/29 新接口参数定义 张俊
V0.2 2017/10/20 新增异常类型ACQ.BUSINESS_TIMEOUT_ERROR(业务超时) 陈宋东
V0.3 2019/05/05 增加代理密码,和相关错误码 陈宋东
V0.4 2021/10/14 增加提现到账卡类型 康少雄
V0.5 2021/12/27 支持国密 王晶
V0.6 2024/08/27 新增业务代码business_code 丘裕文

2.接口说明

(1)场景说明

1、实时提现交易(一般户到银行卡)-V3.0版本

(2)接口说明

1、实时提现交易(一般户到银行卡)-V3.0版本

3.请求地址

环境 HTTPS请求地址
正式环境 https://commonapi.ysepay.com/gateway.do

4.请求参数说明

4.1 公共请求参数

参数 类型(字节长度) 必填 参数说明
method String(1,128) Y 接口名称 固定值 ysepay.merchant.withdraw.quick.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.0 当前版本:3.0
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
bank_account_no String(1,32) Y 到账卡为结算卡时可空,示例值:1000000000000000;
card_type String(1,1) N 到账卡类型 1-提现卡 2-结算卡,为空则默认1-提现卡
business_code String(1,10) N 业务代码,枚举值: 00510003(支付账户提现[16] )

5.响应参数说明

银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。

请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

5.1 公共响应参数

参数 类型(字节长度) 必填 参数说明
sign String Y 签名字符串,Base64编码
ysepay_merchant_withdraw_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 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 参考收款方手续费
payer_fee Number(10,2) Y 参考付款方手续费

6.服务器异步通知参数

银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。

请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

参数 类型(字节长度) 必填 参数说明
out_trade_no String(1,32) Y 商户系统生成的订单号
trade_status String(32) Y 交易目前所处的状态。状态的值:TRADE_SUCCESS|DISHONOUR_SUCCESS具体详示例值:附录9.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编码

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";
        //ys公钥证书存放地址 建议配置在项目的配置文件里面
        String publicKeyFilePath = "D:\\opensdk\\businessgate.cer";
        //私钥证书密钥,建议配置在项目的配置文件里面
        String privateKeyPassworde = "123456";

        //银盛支付服务器主动通知商户网站里指定的页面http路径
        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");//商户生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天
        bizContent.put("merchant_usercode", "hyfz_test2");//商户号
        bizContent.put("currency", "CNY");//暂时只支持币种:CNY(人民币)
        bizContent.put("total_amount", "0.04");//提现的总金额。单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。Number(10,2)指10位长度,2位精度
        bizContent.put("subject", "提现了");//订单说明
        bizContent.put("shopdate", "20211012");//商户日期(该参数做交易与查询时需要一致) 该日期需在当日的前后一天时间范围之内
        bizContent.put("bank_account_no", "6212260488888888888");//银行帐号
        req.setParamData(bizContent);
        String result = null;
        try{
            logger.info("实时提现(一般户到银行卡)调用sdk接口addScanMerc请求入参为:"+ JSONObject.toJSONString(req));
            //根据返回结果处理自己的业务逻辑,result内容详见接口文档
            result = MercFundApi.withdrawQuick(req);
        }catch (Exception e){
            logger.info("实时提现(一般户到银行卡)失败:"+ e.getMessage());
        }

8.附录

8.1 业务错误码

错误码 错误描述 解决方案
ACQ.SYSTEM_ERROR 系统错误 请调用查询接口查询订单状态
ACQ.BUSINESS_TIMEOUT_ERROR 业务超时 请调用查询接口查询订单状态
ACQ.INVALID_PARAMETER 参数无效 检查请求参数,修改后重新发起请求
ACQ.ORGNO_CHECK_FAILD 代理商与商户的机构关系不匹配 检查请求参数,修改后重新发起请求
ACQ.PROXY_CHECK_FAILD 代理关系检查失败 比如委托关系不存在, 代理密码不一致
ACQ.PROXY_CHECK_PARAM 代理关系参数验证失败 比如代理密码解密失败,或者代理密码有值,但委托商户号无值
PARAM_ERROR 参数错误 检查请求参数,修改后重新发起请求
REPEAT_ORDER 订单重复 该笔订单已受理,请使用新订单号发起请求
RISK_ERROR 风控检查异常 请检查风控是否有异常,然后再重新发起
ROUTE_ERROR 路由失败 请联系客服或市场技术支持人员
ACCOUNT_ERROR 账户扣款失败 请联系客服或市场技术支持人员
FEE_ERROR 计费失败 请联系客服或市场技术支持人员
DEAL_ERROR 处理失败 请重新发起提现受理请求
STATE_ERROR 交易状态异常 比如D0提现配置未配置

8.2 交易状态

枚举名称 枚举说明
TRADE_ACCEPT_SUCCESS 受理成功
TRADE_SUCCESS 交易成功
TRADE_FAILURE 交易失败
DISHONOUR_SUCCESS 退票成功

{"code":200,"message":"成功","data":null,"list":null}

results matching ""

    No results matching ""