分账退款接口

1.修订记录

2.接口说明

（1）场景说明

1、分账完成后，可以调用此接口中进行分账退款

（2）接口说明

1、分账退款接口

3.请求地址

4.请求参数说明

4.1 公共请求参数

4.2 业务请求参数

参数名biz_content,值为一个json格式对象，下面列表描述json对象的值

4.2.1 分账退款 refund_split_info

4.2.2 原分账信息 order_div_list

5.响应参数说明

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

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

5.1 公共响应参数

5.2 业务响应参数

5.3 分账异步通知参数

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

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

6.样例

6.1 sdk调用示例

• 银盛将与服务端交互的接口封装在开发工具包（SDK）中，开发者无需自行实现同服务端交互的复杂逻辑，直接将SDK导入自己的工程后，通过sdk示例代码实现同银盛服务端的交互

        OnlineReqDataVo req = new OnlineReqDataVo();
        //请求路径,建议配置在项目的配置文件里面
        String reqUrl = "https://openapi.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");//原订单号
        bizContent.put("shopdate", "20211012");//商户日期(该参数做交易与查询时需要一致) 该日期需在当日的前后一天时间范围之内
        bizContent.put("trade_no", "01O211012233547058");//银盛交易号, 可空
        bizContent.put("refund_amount", "0.01");//需要退款的金额，该金额不能大于订单金额,单位为元，支持两位小数，Number(10,2)指10位长度，2位精度
        bizContent.put("refund_reason", "不想买了");//退款的原因说明，该参数最长为50��汉字。
        bizContent.put("out_request_no", "RD2012061713107");//标识一次退款请求，同一笔交易多次退款需要保证唯一。该参数支持汉字，最大长度为16个。用同一订单号同一退款流水号继续退款时，则会返回第一次退款的结果不会继续退款
        bizContent.put("is_division", "01");//可空, 原交易是否参与分账（01或空代表是，02代表否）
        //退款分账明细，分账退款金额总和等于退款金额，当原交易参与分账时，该参数必传，原交易不参与分账，该参数无值
        JSONArray refundSplitInfo = new JSONArray();
        JSONObject infoObject = new JSONObject();
        infoObject.put("refund_mer_id","y2110091506590197537");//分账退款商户号
        infoObject.put("refund_amount","0.01");//分账退款金额
        refundSplitInfo.add(infoObject);
        bizContent.put("refund_split_info", refundSplitInfo);//退款分账明细，可空
        bizContent.put("ori_division_mode", "01");//原交易分账模式（01：比例，02：金额），可空
        //原订单交易分帐信息，当原交易参与分账时，该参数必传，原交易不参与分账，该参数无值
        JSONArray orderDivList = new JSONArray();
        infoObject = new JSONObject();
        infoObject.put("division_mer_id","hyfz_test2");//分账商户号
//        infoObject.put("division_amount","0.09");//分账金额, 可空按分账模式可填
        infoObject.put("division_ratio","0.90");//分账比例,分账比例之和必须为1, 可空按分账模式可填
        infoObject.put("is_charge_fee","02");//是否收取手续费（01：是，02否）若配置手续费收支分离，该参数配置的手续费承担方不生效
        orderDivList.add(infoObject);
        infoObject = new JSONObject();
        infoObject.put("division_mer_id","y2110091506590197537");//分账商户号
//        infoObject.put("div_amount","0.09");//分账金额, 可空按分账模式可填
        infoObject.put("div_ratio","0.10");//分账比例,分账比例之和必须为1, 可空按分账模式可填
        infoObject.put("is_charge_fee","01");//是否收取手续费（01：是，02否）
        orderDivList.add(infoObject);
        bizContent.put("order_div_list", orderDivList);//原订单交易分帐信息，可空
        req.setParamData(bizContent);
        String result = null;
        try{
            logger.info("分账退款交易调用sdk接口addScanMerc请求入参为:"+ JSONObject.toJSONString(req));
            result = MercFundApi.tradeRefundSplit(req);
            //根据返回结果处理自己的业务逻辑,result内容详见接口文档
        }catch (Exception e){
            logger.info("分账退款交易接口失败:"+ e.getMessage());
        }

6.2 API接口代码示例

• 需要开发者自己封装调用逻辑，实现调用银盛api接口同银盛服务端交互,该示例没有加签验签及发送http请求代码，需自行下载demo查看。

public static void main(String[] args) {
        Map<String, String> mapData = new HashMap<>();
        mapData.put("partner_id", "hyfz_test2");
        mapData.put("method", "ysepay.online.trade.refund.split");
        mapData.put("timestamp", DateUtil.getDateNow());
        mapData.put("sign_type", "RSA");
        mapData.put("charset", "utf-8");
        mapData.put("version", "3.0");
        mapData.put("notify_url","http://127.0.0.1");

        JSONObject json = new JSONObject();
        json.put("out_trade_no", "20210722174831981103602311553304");
        json.put("shopdate","20210722");
        json.put("refund_amount","0.01");
        json.put("refund_reason","退款测试");
        json.put("is_division","02");
        json.put("out_request_no",SerialGenerator.getOrder());
        json.put("trade_no", "");
        mapData.put("biz_content",json.toString());
        //参数签名
        try{
            String sign = YsPaySignUtils.sign(mapData);
            mapData.put("sign",sign);
        } catch (Exception e){
            log.info("签名异常："+e);
        }
        //调用查询接口
        log.info("请求报文："+ CommonUtil.mapToString(mapData));
        String result = HttpRequest.sendPost("https://openapi.ysepay.com/gateway.do",CommonUtil.mapToString(mapData));
        log.info("接口回执："+result);
        boolean resultVerify = false;
        //接口回执验签
        try{
            resultVerify = YsPaySignUtils.resultVerify(result,"ysepay_online_trade_refund_split_response");
        } catch (Exception e){
            log.info("验签异常："+e);
        }
        if(!resultVerify){
            log.info("验签失败");
        }
    }

6.3 分账退款 refund_split_info

[{
    "refund_mer_id": "分账退款商户号",
    "refund_amount": "分账退款金额"
}]

7.附录

7.1 分账退款登记请求错误码

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