第三方软件接入代收保平台接口实现规范v16.docx

1、第三方软件接入代收保平台接口实现规范v16代收保平台供物流软件调用的接口规范V1.6版本历史版本日期作者说明V1.02015-08-05王新建V1.12016-01-12王添加字段：中转地、货号、物流公司商户号V1.22016-02-22邰添加字段：中转费、中转费结算方式V1.22016-02-23邰整理字段类型V1.32016-03-10邰添加保付服务字段、接口V1.42016-04-22邰添加即时付运单修改（出库付款前）V1.52016-05-13邰撤销服务(草稿)V1.62016-05-14邰保付对账(草稿)接口采用：ASP.NETWebAPI构建接口地址：http:/121.41.27

2、.157:8082使用时请在http headers里添加key值x-token，值为平台提供给软件的token添加key值Content-Type，值为application/json使用时请在http body里添加raw JSON(application/json)数据内容使用代收保注意：1、 运单保存后，禁止修改运单信息。2、 收款金额和申请金额一致。3、 上传、收款操作请求添加：bankaccountstring发货人卡号bankaccountnamestring发货人姓名sendertelstring发货人电话servicetypeint服务类型1:信保付2:即时付3:易垫付ser

3、viceurlstring服务回传地址不可空，用于付款后回传给软件结果(平台通过RestSharp进行回传结果，请参考网上的资料写接收方法)，格式必须如下0.0.0.0:1234/api/bfservice目录1上传运单(waybill) 41.1接口地址 41.2 Request(请求) 41.2.1字段类型 41.2.2数据格式 61.3 Response(应答) 71.3.1字段类型 71.3.2数据格式 82运单业务 102.1装车(loading) 112.1.1 Request(请求) 112.1.2 Response(应答) 122.2发车(send) 132.2.1 Reque

4、st(请求) 132.2.2 Response(应答) 142.3到站接车(arrive) 152.3.1 Request(请求) 152.3.2 Response(应答) 162.4货物出库(pickup) 172.4.1 Request(请求) 172.4.2 Response(应答) 192.5货物签收(check) 202.5.1 Request(请求) 202.5.2 Response(应答) 212.6收款(finpay) 232.6.1 Request(请求) 232.6.2 Response(应答) 262.7款项核销(finbalance) 282.7.1 Request(请

5、求) 282.7.2 Response(应答) 292.8回款(finback) 302.8.1Request(请求) 302.8.2Response(应答) 312.9接款(finreceive) 332.9.1Request(请求) 332.9.2Response(应答) 332.10放款(finfk) 352.10.1Request(请求) 352.10.2Response(应答) 362.11 修改(modify) 372.11.1 Request(请求) 372.11.2 Response(应答) 403撤销业务 423.1Request(请求) 423.1.1字段类型 423.1.

6、2数据格式 423.2Response(应答) 433.2.1字段类型 433.2.2数据格式 444代收保 454.1服务类型(servicetype) 454.2回传地址(serviceurl) 451上传运单(waybill)1.1接口地址操作URI描述POST/api/waybill将软件里的运单上传至平台1.2Request(请求)1.2.1字段类型名称类型必填描述timeint请求时间，unix时间戳logisticsidstring物流公司商户号uploadtimeint上传时间，unix时间戳keyidstring订单id（32位uuid）保证运单的唯一docnostring运

7、单编号fromlocationstring起点tolocationstring终点transferlocationstring中转站sendermembernostring发货人会员号sendernamestring发货人sendermobilestring发货人手机sendertelstring发货人电话senderaddressstring发货地址receivernamestring收货人receivermobilestring收货人手机receivertelstring收货人电话receiveraddressstring收货地址goodsnamestring货名goodsnostring

8、货号goodsquantityint件数goodsvolumedouble体积（方）goodsweightdouble重量（吨）freightdecimal运费freighttypeint运费结算方式1-提付2-已付现付3-回付4-扣付5-月结6-已支7-未支8-垫付transferfeedecimal中转运费transferfeetypeint中转运费结算方式1-提付2-已付现付3-回付4-扣付5-月结6-已支7-未支8-垫付dskamountdecimal代收款dsksxfdecimal代收款手续费dsktypeint代收款类型0-提付1-垫付banknamestring银行名称accou

9、ntstring帐号accountnamestring户名insurancevaluedecimal保额insurancefeedecimal保费insurancefeetypeint保费结算方式1-提付2-已付现付3-回付4-扣付5-月结6-已支7-未支8-垫付packageint包装形式0-没有 1-木箱 2-纸箱 3-铁件4-袋子5-塑料packagefeedecimal包装费packagefeetypeint包装费结算方式1-提付2-已付现付3-回付4-扣付5-月结6-已支7-未支8-垫付pickupint是否上门提货pickupfeedecimal提货费pickupfeetypein

10、t提货费结算方式1-提付2-已付现付3-回付4-扣付5-月结6-已支7-未支8-垫付deliverint是否送货上门deliverfeedecimal送货费deliverfeetypeint送货费结算方式1-提付2-已付现付3-回付4-扣付5-月结6-已支7-未支8-垫付receiptcountint回单数receiptfeedecimal回单费receiptfeetypeint回单费结算方式1-提付2-已付现付3-回付4-扣付5-月结6-已支7-未支8-垫付remarkstring备注createtimeint下单时间servicetypeint服务类型1:信保付2:即时付3:易垫付serv

11、iceurlstring服务回传地址不可空，用于付款后回传给软件结果(平台通过RestSharp进行回传结果，请参考网上的资料写接收方法)，格式必须如下0.0.0.0:1234/api/bfservice1.2.2数据格式 time: 请求时间，unix时间戳 logisticsid: 物流公司商户号 uploadtime: 上传时间，unix时间戳 waybilllist: keyid: 订单id （32位uuid Guid.NewGuid().ToString(“N”)） docno: 运单编号 fromlocation: 起点 tolocation: 终点 transferlocatio

12、n: 中转地 sendermemberno: 发货人会员号sendername: 发货人 sendermobile: 发货人手机 sendertel: 发货人电话 senderaddress: 发货地址 receivername: 收货人 receivermobile: 收货人手机 receivertel: 收货人电话 receiveraddress: 收货地址 goodsname: 货名 goodsno: 货号 goodsquantity: 件数 goodsvolume: 体积（方） goodsweight: 重量（吨） freight: 运费 freighttype: 运费结算方式 tra

13、nsferfee: 中转运费 transferfeetype: 中转运费结算方式 dskamount: 代收款 dsksxf: 代收款手续费 dsktype: 代收款类型 bankname: 银行名称 account: 帐号 accountname: 户名 insurancevalue: 保额 insurancefee: 保费 insurancefeetype: 保费结算方式 package: 包装形式 packagefee: 包装费 packagefeetype: 包装费结算方式 pickup: 是否上面提货 pickupfee: 提货费 pickupfeetype: 提货费结算方式 del

14、iver: 是否送货上门 deliverfee: 送货费 deliverfeetype: 送货费结算方式 receiptcount: 回单数 receiptfee: 回单费 receiptfeetype: 回单费结算方式 remark: 备注 createtime: 下单时间 servicetype: 服务类型 serviceurl: 服务回传地址 , 1.3 Response(应答)1.3.1字段类型名称类型必填描述statuscodeint状态码（200：成功 401：未授权，500：服务器内部错误）msgstring消息timeint上传时间，unix时间戳keyidstring对应re

15、quest中的keyidstatusint处理状态。1：接收成功 0：接收失败statusmsgstring处理消息businostring业务流水号retcodestring返回结果成功：1001；失败：1002；参数不合法（失败）:0000；交易超时:1007（当为1007时软件需要调用ApplyServiceStatus接口再次查询结果，然后根据查询结果进行运单的存储）；交易异常（失败）：1018；交易过程中某些数据查找不到（失败）：1019retmsgstring返回结果信息如：交易成功servicefeestring服务费verifycodestring标签serviceamount

16、string金额bfamountstring保付金额shh商户号waybillno运单号waybillid运单标识servicetypestring服务类型1.3.2数据格式statuscode: 状态码（200：成功 401：未授权，500：服务器内部错误） msg:消息 time: 响应时间，unix时间戳 waybilllist: keyid: 对应request中的keyid status: 处理状态。1：接收成功 0：接收失败 statusmsg: 处理消息 bfinfo: Busino: 业务流水号 Retcode: 返回结果Retmsg: 返回结果信息如：交易成功Servicef

17、ee: 服务费Verifycode: 标签Serviceamount: 金额Bfamount: 保付金额Shh:商户号Waybillid: 运单标识Waybillno:运单号Servicetype: 服务类型 , 2运单业务操作URI描述POST/api/wbaction/actionAction 说明loading 装车send 发车arrive 到站接车pickup 货物出库check 货物签收finpay 收款finbalance 款项核销finback 回款finreceive 接款finfk 放款modify 修改2.1装车(loading)操作URI描述POST/api/wbact

18、ion/loading装车2.1.1 Request(请求)2.1.1.1字段类型名称类型必填描述timeint请求时间，unix时间戳logisticsidstring物流公司商户号loadingtimeint装车时间unix时间戳loadingnostring装车编号vehiclenostring车牌号drivernamestring司机drivertelstring司机电话gpsnamestringgpsoptusernamestring操作员remarkstring备注keyidstring对应waybill中的keyid 32位UUIDdocnostring对应waybill中的do

19、cno: 运单号2.1.1.2数据格式 time: 请求时间，unix时间戳 logisticsid: 物流公司商户号loadingtime: 装车时间loadingno: 装车编号vehicleno: 车牌号drivername: 司机drivertel: 司机电话gpsname: gpsoptusername: 操作员remark: 备注waybilllist: 装车明细 keyid: 运单id docno: 运单号 2.1.2 Response(应答)2.1.2.1字段类型名称类型必填描述statuscodeint状态码（200：成功 401：未授权，500：服务器内部错误）msgstr

20、ing消息timeint响应时间，unix时间戳keyidstring对应request中的keyidstatusint处理状态。1：接收成功 0：接收失败statusmsgstring处理消息2.1.2.2数据格式statuscode: 状态码（200：成功 401：未授权，500：服务器内部错误） msg:消息 time: 响应时间，unix时间戳 waybilllist: keyid: 运单id status: 处理状态。1：处理成功 0：处理失败 statusmsg: 处理消息 , 2.2发车(send)操作URI描述POST/api/wbaction/send发车2.2.1 Requ

21、est(请求)2.2.1.1字段类型名称类型必填描述timeint请求时间，unix时间戳logisticsidstring物流公司商户号sendtimeint发车时间unix时间戳sendnostring发车单号fromlocationstring起点tolocationstring终点promisearrivedtstring预计到达日期optusernamestring操作员remark备注keyidstring对应waybill中的keyid 32位UUIDdocnostring对应waybill中的docno: 运单号2.2.1.2数据格式time: 请求时间，unix时间戳logi

22、sticsid: 物流公司商户号sendtime: 发车时间sendno: 发车单号fromlocation: 起点tolocation: 终点promisearrivedt: 预计到达日期optusername: 操作员remark: 备注waybilllist: 发车明细 keyid: docno: 2.2.2 Response(应答)2.2.2.1字段类型名称类型必填描述statuscodeint状态码（200：成功 401：未授权，500：服务器内部错误）msgstring消息timeint响应时间，unix时间戳keyidstring对应request中的keyidstatusint

23、处理状态。1：接收成功 0：接收失败statusmsgstring处理消息2.2.2.2数据格式statuscode: 状态码（200：成功 401：未授权，500：服务器内部错误） msg:消息 time: 响应时间，unix时间戳 waybilllist: keyid: 运单id status: 处理状态。1：处理成功 0：处理失败 statusmsg: 处理消息 , 2.3到站接车(arrive)操作URI描述POST/api/wbaction/arrive到站接车2.3.1 Request(请求)2.3.1.1字段类型名称类型必填描述timeint请求时间，unix时间戳logisti

24、csidstring物流公司商户号arrivetimeint接车时间unix时间戳arrivenostring接车单号arrivenodenamestring接车网点名称optusernamestring操作员remark备注keyidstring对应waybill中的keyid 32位UUIDdocnostring对应waybill中的docno: 运单号arrivestatusint接车状态 1：正常 2：异常arriveremarkstring接车异常说明2.3.1.2数据格式time: 请求时间，unix时间戳logisticsid: 物流公司商户号arrivetime: 接车时间ar

25、riveno: 接车单号arrivenodename: 接车网点名称optusername: 操作员remark: 备注waybilllist: 接车明细 keyid: 运单id docno: 运单号 arrivestatus: 接车状态 1：正常 2：异常 arriveremark: 接车异常说明 2.3.2 Response(应答)2.3.2.1字段类型名称类型必填描述statuscodeint状态码（200：成功 401：未授权，500：服务器内部错误）msgstring消息timeint响应时间，unix时间戳keyidstring对应request中的keyidstatusint处理状态。1：接收成功 0：接收失败statusmsgstring处理消息2.3.2.2数据格式statuscode: 状态码（200：成功 401：未授权，500：服务器内部错误） msg:消息 time: 响应时间，unix时间戳 waybilllist: keyid: 运单id status: 处理状态。1：处理成功 0：处理失败 statusmsg: 处理消息 , 2.4货物出库(pickup)操作UR