订单分账
功能概述
商户通过分账接口对下单时请求分账的交易进行分账。
注意:如果分给收单商户自身,仍需主动调用分账接口,并传递具体的分账信息(splitDetails)。如果不调用分账接口,未分账的资金将始终处于挂起状态,不会自动结算给收单商户
接口地址
https://apis.5upay.com/split/order
参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
merchantId |
商户编号 |
varchar(9) |
商户在首信易系统的唯一id,可在商户后台查看 |
M |
requestId |
分账订单号 |
varchar(50) |
商户自行定义的分账订单号,不可重复。 |
M |
partnerId |
服务商 id |
varchar(9) |
服务商在首信易系统的唯一id,可在商户后台查看 |
C |
orderId |
原交易订单号 |
varchar(50) |
此项传订单交易完成以后的requestId |
M |
totalSplitAmount |
分账金额 |
varchar(20) |
单位:分,可填写正整数、-1,填写“-1”时为剩余未分账金额全额分账,仅可填写一条分账明细信息 |
M |
notifyUrl |
通知地址 |
varchar(200) |
服务器通知:订单成功后会向该地址发送五次成功通知,该地址可以带参数,如: “https://www.5upay.com/callback.action?test=test”. |
M |
splitDetails |
分账信息 |
Json(数组) |
分账信息,见下表 |
M |
hmac |
参数签名 |
varchar(500) |
商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 |
M |
以上参数值中不能包含以下特殊字符’”&<>()
请求参数(splitDetails,分账信息)
参数名称 |
参数中文名称 |
类型& 长度 |
参数说明 |
是否必填 |
subSplitRequestId |
分账明细订单号 |
varchar(13) |
分账明细订单号,商户自行拟定,不可重复。 |
M |
splitAccType |
分账类型 |
固定值 |
MERCHANT_ACC 商户 |
M |
WALLET_ACC 钱包 |
splitAccId |
分账方编号 |
varchar(30) |
分账类型为商户时此参数传商户的merchantId(可传主商户商编) |
M |
分账类型为钱包时此参数传用户的walletId |
splitAmount |
分账明细订单金额 |
varchar(20) |
单位:分,可填写正整数、-1,填写“-1”时为剩余未分账金额全额分账 |
M |
remark |
分账备注 |
varchar(300) |
分账备注 |
M |
参数示例
{
"hmac": null,
"merchantId": "100000000",
"splitDetails": [{
"subSplitRequestId": "MC20181129008",
"splitAccType": "MERCHANT_ACC",
"splitAccId": "890000593",
"splitAmount": "100",
"remark": "备注"
}],
"orderId": "8a0be93c633eec9c0163b55bb2d42d73",
"requestId": "1488794408626",
"notifyUrl": "http://qa.ehking.com/sdk/onlinepay/refundNotify",
"totalSplitAmount": " 100 "
}
请求同步返回参数列表
参数名称 |
参数中文名称 |
参数说明 |
merchantId |
商户编号 |
同请求参数 |
requestId |
分账订单号 |
同请求参数 |
partnerId |
服务商 id |
同请求参数 |
orderId |
原交易订单号 |
首信易支付原交易订单号 |
status |
请求状态 |
SUCCESS 成功 |
FAILED 失败 |
ERROR 错误 |
errorMessage |
错误信息 |
错误信息
|
hmac |
参数签名 |
首信易生成的参数签名结果,验签过程请参考解密流程 |
参数示例
{
"receiptOrderId":"8a0be93c633eec9c0163b55bb2d42d73",
"merchantId": "100000000",
"requestId": "1527756058867",
"hmac": "d9c980e5967cc81ccc6478392c7dfabc",
"status": "SUCCESS"
}
订单异步返回参数列表
参数名称 |
参数中文名称 |
参数说明 |
merchantId |
商户编号 |
同请求参数 |
requestId |
分账订单号 |
同请求参数 |
partnerId |
服务商 id |
同请求参数 |
splitAmount |
分账金额 |
单位:分,1 元=100 分 |
subSplitRequestId |
分账明细订单号 |
同请求参数 |
splitStatus |
分账状态 |
INIT 处理中 |
FINISHED 已完成 |
status |
明细分账状态 |
SUCCESS 成功 |
completeDateTime |
明细分账完成时间 |
格式:yyyy-MM-dd HH:mm:ss
|
remark |
备注 |
备注 |
hmac |
参数签名 |
首信易生成的参数签名结果,验签过程请参考解密流程
|
参数示例
{
"subSplitRequestId": "832f3f1bdab749849fd5bcf46d3ff7e3",
"merchantId": "100000000",
"requestId": "1527746602492",
"splitAmount": "100",
"hmac": "c5ab9be868a4b79872739362995b39db",
"splitStatus": "INIT",
"completeDateTime ": "2020-07-22 15:22:30",
"remark": "备注",
"status": "SUCCESS"
}