第三方软件接入代收保平台接口实现规范v16Word文档下载推荐.docx
《第三方软件接入代收保平台接口实现规范v16Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《第三方软件接入代收保平台接口实现规范v16Word文档下载推荐.docx（81页珍藏版）》请在冰豆网上搜索。
int
服务类型
1:
信保付
2:
即时付
3:
易垫付
serviceurl
服务回传地址
不可空，用于付款后回传给软件结果（平台通过RestSharp进行回传结果，请参考网上的资料写接收方法），格式必须如下0.0.0.0:
1234/api/bfservice
目录
1上传运单（waybill）4
1.1接口地址4
1.2Request（请求）4
1.2.1字段类型4
1.2.2数据格式6
1.3Response（应答）7
1.3.1字段类型7
1.3.2数据格式8
2运单业务10
2.1装车（loading）11
2.1.1Request（请求）11
2.1.2Response（应答）12
2.2发车（send）13
2.2.1Request（请求）13
2.2.2Response（应答）14
2.3到站接车（arrive）15
2.3.1Request（请求）15
2.3.2Response（应答）16
2.4货物出库（pickup）17
2.4.1Request（请求）17
2.4.2Response（应答）19
2.5货物签收（check）20
2.5.1Request（请求）20
2.5.2Response（应答）21
2.6收款（finpay）23
2.6.1Request（请求）23
2.6.2Response（应答）26
2.7款项核销（finbalance）28
2.7.1Request（请求）28
2.7.2Response（应答）29
2.8回款（finback）30
2.8.1Request（请求）30
2.8.2Response（应答）31
2.9接款（finreceive）33
2.9.1Request（请求）33
2.9.2Response（应答）33
2.10放款（finfk）35
2.10.1Request（请求）35
2.10.2Response（应答）36
2.11修改（modify）37
2.11.1Request（请求）37
2.11.2Response（应答）40
3撤销业务42
3.1Request（请求）42
3.1.1字段类型42
3.1.2数据格式42
3.2Response（应答）43
3.2.1字段类型43
3.2.2数据格式44
4代收保45
4.1服务类型（servicetype）45
4.2回传地址（serviceurl）45
1上传运单（waybill）
1.1接口地址
操作
URI
描述
POST
/api/waybill
将软件里的运单上传至平台
1.2Request（请求）
1.2.1字段类型
名称
类型
必填
time
请求时间，unix时间戳
logisticsid
物流公司商户号
uploadtime
上传时间，unix时间戳
keyid
订单id（32位uuid）保证运单的唯一
docno
运单编号
fromlocation
起点
tolocation
终点
transferlocation
中转站
sendermemberno
发货人会员号
sendername
发货人
sendermobile
发货人手机
senderaddress
发货地址
receivername
收货人
receivermobile
收货人手机
receivertel
收货人电话
receiveraddress
收货地址
goodsname
货名
goodsno
货号
goodsquantity
件数
goodsvolume
double
体积（方）
goodsweight
重量（吨）
freight
decimal
运费
freighttype
运费结算方式
1-提付2-已付现付3-回付4-扣付
5-月结6-已支7-未支8-垫付
transferfee
中转运费
transferfeetype
中转运费结算方式
dskamount
代收款
dsksxf
代收款手续费
dsktype
代收款类型
0-提付1-垫付
bankname
银行名称
account
帐号
accountname
户名
insurancevalue
保额
insurancefee
保费
insurancefeetype
保费结算方式
package
包装形式
0-没有1-木箱2-纸箱3-铁件4-袋子5-塑料
packagefee
包装费
packagefeetype
包装费结算方式
pickup
是否上门提货
pickupfee
提货费
pickupfeetype
提货费结算方式
deliver
是否送货上门
deliverfee
送货费
deliverfeetype
送货费结算方式
receiptcount
回单数
receiptfee
回单费
receiptfeetype
回单费结算方式
remark
备注
createtime
下单时间
1.2.2数据格式
{
time:
请求时间，unix时间戳
logisticsid:
物流公司商户号
uploadtime:
上传时间，unix时间戳
waybilllist:
[
keyid:
订单id（32位uuid–Guid.NewGuid（）.ToString（“N”））
docno:
运单编号
fromlocation:
起点
tolocation:
终点
transferlocation:
中转地
sendermemberno:
发货人会员号
sendername:
发货人
sendermobile:
发货人手机
sendertel:
发货人电话
senderaddress:
发货地址
receivername:
收货人
receivermobile:
收货人手机
receivertel:
收货人电话
receiveraddress:
收货地址
goodsname:
货名
goodsno:
货号
goodsquantity:
件数
goodsvolume:
体积（方）
goodsweight:
重量（吨）
freight:
运费
freighttype:
运费结算方式
transferfee:
中转运费
transferfeetype:
中转运费结算方式
dskamount:
代收款
dsksxf:
代收款手续费
dsktype:
代收款类型
bankname:
银行名称
account:
帐号
accountname:
户名
insurancevalue:
保额
insurancefee:
保费
insurancefeetype:
保费结算方式
package:
包装形式
packagefee:
包装费
packagefeetype:
包装费结算方式
pickup:
是否上面提货
pickupfee:
提货费
pickupfeetype:
提货费结算方式
deliver:
是否送货上门
deliverfee:
送货费
deliverfeetype:
送货费结算方式
receiptcount:
回单数
receiptfee:
回单费
receiptfeetype:
回单费结算方式
remark:
备注
createtime:
下单时间
servicetype:
服务类型
serviceurl:
服务回传地址
},
……
]
}
1.3Response（应答）
1.3.1字段类型
statuscode
状态码（200：
成功401：
未授权，500：
服务器内部错误）
msg
消息
对应request中的keyid
status
处理状态。
1：
接收成功0：
接收失败
statusmsg
处理消息
busino
业务流水号
retcode
返回结果
成功：
1001；
失败：
1002；
参数不合法（失败）:
0000；
交易超时:
1007（当为1007时软件需要调用ApplyServiceStatus接口再次查询结果，然后根据查询结果进行运单的存储）；
交易异常（失败）：
1018；
交易过程中某些数据查找不到（失败）：
1019
retmsg
返回结果信息如：
交易成功
servicefee
服务费
verifycode
标签
serviceamount
金额
bfamount
保付金额
shh
商户号
waybillno
运单号
waybillid
运单标识
1.3.2数据格式
statuscode:
状态码（200：
msg:
响应时间，unix时间戳
[
keyid:
对应request中的keyid
status:
处理状态。
statusmsg:
处理消息
bfinfo:
Busino:
业务流水号
Retcode:
返回结果
Retmsg:
返回结果信息如：
Servicefee:
服务费
Verifycode:
标签
Serviceamount:
金额
Bfamount:
保付金额
Shh:
Waybillid:
运单标识
Waybillno:
Servicetype:
2运单业务
/api/wbaction/{action}
Action说明
loading装车
send发车
arrive到站接车
pickup货物出库
check货物签收
finpay收款
finbalance款项核销
finback回款
finreceive接款
finfk放款
modify 修改
2.1装车（loading）
/api/wbaction/loading
装车
2.1.1Request（请求）
2.1.1.1字段类型
loadingtime
装车时间unix时间戳
loadingno
装车编号
vehicleno
车牌号
drivername
司机
drivertel
司机电话
gpsname
gps
optusername
操作员
对应waybill中的keyid32位UUID
对应waybill中的docno:
运单号
2.1.1.2数据格式
loadingtime:
装车时间
loadingno:
装车编号
vehicleno:
车牌号
drivername:
司机
drivertel:
司机电话
gpsname:
gps
optusername:
操作员
remark:
waybilllist:
[装车明细
{
keyid:
运单id
docno:
}
]
}
2.1.2Response（应答）
2.1.2.1字段类型
响应时间，unix时间戳
2.1.2.2数据格式
处理成功0：
处理失败
2.2发车（send）
/api/wbaction/send
发车
2.2.1Request（请求）
2.2.1.1字段类型
sendtime
发车时间unix时间戳
sendno
发车单号
promisearrivedt
预计到达日期
2.2.1.2数据格式
time:
logisticsid:
sendtime:
发车时间
sendno:
发车单号
fromlocation:
tolocation:
promisearrivedt:
预计到达日期
[发车明细
{
}
2.2.2Response（应答）
2.2.2.1字段类型
2.2.2.2数据格式
2.3到站接车（arrive）
/api/wbaction/arrive
到站接车
2.3.1Request（请求）
2.3.1.1字段类型
arrivetime
接车时间unix时间戳
arriveno
接车单号
arrivenodename
接车网点名称
arrivestatus
接车状态1：
正常2：
异常
arriveremark
接车异常说明
2.3.1.2数据格式
arrivetime:
接车时间
arriveno:
接车单号
arrivenodename:
接车网点名称
[接车明细
arrivestatus:
接车状态1：
arriveremark:
接车异常说明
2.3.2Response（应答）
2.3.2.1字段类型
2.3.2.2数据格式
2.4货物出库（pickup）
UR
升级会员 