担保交易发货通知
1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2017/11/3 |
新接口参数定义 |
邓文泉 |
V0.2 |
2018/05/25 |
补充shopdate参数 |
黄国强 |
V0.3 |
2021/12/27 |
支持国密 |
王晶 |
2.业务说明
(1)场景说明
1、用户在交易时,选择交易类型tran_type为担保交易,需要调用此接口进行发货通知操作
(2)接口说明
1、担保交易发货通知
3.请求地址
4.请求参数说明
4.1公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.online.trade.delivered |
partner_id |
String(20) |
Y |
商户在银盛支付平台开设的用户号[商户号] |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
version |
String(3) |
Y |
接口版本3.0 当前版本 3.0 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
N |
商户系统生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
shopdate |
String(8,8) |
Y |
商户日期(该参数做交易与查询时需要一致) 该日期需在当日的前后一天时间范围之内 示例值:20180525 |
trade_no |
String(1,30) |
N |
该交易在银盛支付系统中的交易流水号。 |
5.返回参数说明
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_trade_delivered_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
out_trade_no |
String(1,32) |
N |
商户系统生成的订单号 |
trade_no |
String(1,30) |
N |
该交易在银盛支付系统中的交易流水号。 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的值: WAIT_BUYER_CONFIRM_GOODS 示例值:附录7.1 |
6.样例-sdk调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互
OnlineReqDataVo req = new OnlineReqDataVo();
String reqUrl = "https://openapi.ysepay.com/gateway.do";
String privateKeyFilePath = "D:\\opensdk\\hyfz_test2.pfx";
String publicKeyFilePath = "D:\\opensdk\\businessgate.cer";
String privateKeyPassworde = "123456";
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", "01O211011208765269");
req.setParamData(bizContent);
String result = null;
try{
logger.info("担保交易发货通知接口调用sdk接口addScanMerc请求入参为:"+ JSONObject.toJSONString(req));
result = MercFundApi.tradeDelivered(req);
}catch (Exception e){
logger.info("担保交易发货通知接口失败:"+ e.getMessage());
}
7.附录
7.1 交易状态
枚举名称 |
枚举说明 |
WAIT_BUYER_PAY |
交易创建,等待买家付款。 |
TRADE_CLOSED |
在指定时间段内未支付时关闭的交易;客户主动关闭订单。 |
TRADE_SUCCESS |
交易成功,且可对该交易做操作,如:多级分润、退款等。 |
TRADE_PART_REFUND |
部分退款成功。 |
TRADE_ALL_REFUND |
全部退款成功。 |
WAIT_SELLER_SEND_GOODS |
买家已付款,等待卖家发货 |
WAIT_BUYER_CONFIRM_GOODS |
卖家已发货,等待买家确认 |