首页 > API文档 > 代收货款API
提供代收货款增值服务，代收货款服务就是卖家先发货，买家收到货后再由快递员代收货款，经由快递公司或快金结算给卖家，全程由快金监控货物安全与资金安全，是一种安全、便捷、时尚的支付和物流方式。支持COD、货款直退、货款垫付。COD为快递公司自有代收货款业务，由快递公司返款给卖家。货款直退和货款垫付是由快递鸟提供的货款提速服务，最快发件后4小时返款，由快递鸟与卖家结算返款。
（1）代收货款服务就是卖家先发货，买家收到货后再由快递员代收货款，经由快递公司或快金结算给卖家。
（2）电商后台订单系统设置订单支持物流代收货款，物流系统设置订单发货时支持代收货款的物流公司。可选的代收货款服务类型包括COD、货款直退、货款垫付。
（3）服务特点：
服务说明
| 服务类型 | 定义 | 支持公司 |
|---|
| COD | 快递公司自有代收货款业务，由快递公司负责返款给卖家。 | 顺丰、龙邦、速腾、京广、韵达、圆通 |
| 货款直退 | 签收后由快金转账返款给卖家。 | 龙邦、顺丰、韵达、EMS、圆通 |
| 货款垫付 | 发件后最快4小时由快金垫付返款给卖家，签收后快递员代收货款结算给快金。 | 龙邦 |
服务价格和返款时效
| 服务类型 | 支持公司 | 单笔限额 | 货款返款时间 | 服务费率 |
|---|
| COD | 顺丰 | 无 | 签收后4-6天 | 与网点商议 |
| 龙邦 | 5万 | 签收后3-7天 | 与网点商议 |
| 速腾 | 1万 | 签收后3-5天 | 与网点商议 |
| 圆通 | 1万 | 签收后一周两返 | 与网点商议 |
| 京广 | 1万 | 签收后3-5天 | 与网点商议 |
| 韵达 | 1万 | 签收后3-7天 | 与网点商议 |
| 货款直退 | 顺丰 | 2万 | 签收后第4个工作日16:00前 | 3元起步，3%，无封顶 |
| 龙邦 | 5万 | 签收后，第2个工作日16:00前 | 1000以下2元，0.2%，10元封顶 |
| 圆通 | 1万 | 签收后第3个工作日16:00前 | 3元起步，1%，100元封顶 |
| 韵达 | 1万 | 签收后第3个工作日16:00前 | 3元起步，0.8%，100元封顶 |
| EMS | 3万 | 签收后每周二、四 16:00 | 1% |
| 货款垫付 | 龙邦 | 3000 | 12点前发件，当天16前；
12点后发件，第2个工作日11点前 | 每笔2元 |
快递公司服务范围
| 支持公司 | 定义 |
|---|
| 顺丰 | 深圳－全国
8000个支持网点 |
| 龙邦 | 广东省－广东省
300个支持网点 |
| 圆通 | 全国-全国
10000个支持网点 |
| 速腾 | 广东省－广东省
250个支持网点 |
| 京广 | 广东省－广东省
240个支持网点 |
| 韵达 | 全国－全国
7000个支持网点 |
| EMS | 深圳市－全国
72个支持网点 |
COD
货款直退/货款垫付
1用户信息类
1.1用户注册接口
1.1.1功能说明
为第三方平台用户提供注册接口，方便平台用户接入快递鸟服务，同时也方便快递鸟为平台用户提供查询、订阅、下单、金融等全方位物流服务。
1.1.2接口规则
(1)、接口只支持Json格式参数，接口指令9001。只支持POST请求方式，utf-8编码。
(2)、测试地址：http://testapi.kdniao.com:8081/api/reg
(3)、正式地址：https://api.kdniao.com/api/reg
1.1.3系统级输入参数
1.1.4应用级输入参数
1.1.5返回结果参数
1.1.6结果代码表示的含义
1.1.7Json请求示例
{
"MemberCode": "YQ10001",
"CompanyName": "某公司名称",
"SiteName": "某站点或商城名称",
"Name": "李某某",
"Mobile": "18888888888",
"Email": "yourname@yourdomain.com",
"SiteUrl": "http://www.yourdomain.com",
"JoinTime": "2016-03-20 00:00:00"
}
1.1.8Json请求返回示例
{
"MemberCode": "YQ10001",
"Success": true,
"Reason": "",
"EBusinessID": "1300001",
"AppKey": "37dd1e35-f705-40e5-b9ae-3231e18c57f7",
"ParentEBusinessID" : "1255666"
}
1.2更新用户信息
1.2.1功能说明
更新用户在收派宝系统中的注册信息。
1.2.2接口规则
(1)、接口只支持Json格式参数，接口指令CMD1002。只支持POST请求方式，utf-8编码。
(2)、测试地址：http://testapi.kdniao.com:8081/api/agencyfund
(3)、正式地址：https://api.kdniao.com/api/agencyfund
1.2.3 系统级输入参数
1.2.4 应用级输入参数
1.2.5 返回结果参数
1.2.6 JSON请求示例
{
"LinkMan": "hoo",
"Phone": "15223830814",
"Address": "深圳",
"IdentityCardNo": "",
"IdentityCardPicA": "",
"IdentityCardPicB": ""
}
1.2.7 JSON返回示例
{
"Success": true,
"Message": "修改成功",
"RequestType": "cmd1002",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": ""
}
1.3 查询用户信息
1.3.1 功能说明
查询收派宝用户的信息，包含服务状态的开通。
1.3.2 接口规则
(1)、接口指令cmd1003。
1.3.3 系统级输入参数
1.3.4 应用级输入参数
无
1.3.5 返回结果参数
1.3.6 Json请求示例
{
}
1.3.7 Json请求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1003",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "147adf16-8ef2-48d3-8c20-5fbb343ff8d4",
"UserName": "test04@1261602@test",
"LinkMan": "",
"Phone": "15612345678",
"OneLevelAgent": "test",
"TwoLevelAgent": "test_fafa",
"Services": [
{
"ServicesCode": "COD",
"ServiceName": "普通代收服务",
"ValidDate": "",
"StartDate": "2017-01-16"
},
{
"ServicesCode": "CODFAST",
"ServiceName": "网点速退",
"ValidDate": "",
"StartDate": "2017-01-16"
}
]
}
1.4 提交返款银行信息
1.4.1 功能说明
设置用户代收货款订单的银行返款信息。
1.4.2 接口规则
(1)、接口指令CMD1009。
1.4.3 系统级输入参数
1.4.4 应用级输入参数
1.4.5 返回结果参数
1.4.6 Json请求示例
{
"BankType": "0",
"BankAccountNo": "62266226622662266226",
"BankAccountName": "hoo",
"BankName": "招商银行",
"BankBranch": "",
"BankCardPicA": "",
"BankCardPicB": ""
}
1.4.7 Json请求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1003",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "147adf16-8ef2-48d3-8c20-5fbb343ff8d4",
"UserName": "test04@1261602@test",
"LinkMan": "",
"Phone": "15612345678",
"OneLevelAgent": "test",
"TwoLevelAgent": "test_fafa",
"Services": [
{
"ServicesCode": "COD",
"ServiceName": "普通代收服务",
"ValidDate": "",
"StartDate": "2017-01-16"
},
{
"ServicesCode": "CODFAST",
"ServiceName": "网点速退",
"ValidDate": "",
"StartDate": "2017-01-16"
}
]
}
}
1.5 查询返款银行信息
1.5.1 功能说明
查询代收货款订单的银行返款信息。
1.5.2 接口规则
(1)、接口指令CMD1008。
1.5.3 系统级输入参数
1.5.4 应用级输入参数
1.5.5 返回结果参数
1.5.6 Json请求示例
{
"BankType": "0"
}
1.5.7 Json请求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1008",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "bee49a46-5852-45a0-b706-fd60e793e1ef"
}
}
1.6 查询用户额度
1.6.1 功能说明
查询用户的代收货款的额度限制和当前可用额度。
1.6.2 接口规则
(1)、接口指令CMD1014。
1.6.3 系统级输入参数
1.6.4 应用级输入参数
1.6.5 返回结果参数
1.6.6 Json请求示例
{
"ServicesCode": "CODPAY"
}
1.6.7 Json请求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1014",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"UserGuid": "8525344E-3BAF-4B36-8672-97E3403061B3",
"LimitAmount": 10000,
"EnabledAmount": 10000
}
}
2 服务申请类
2.1 垫付业务申请
2.1.1 功能说明
垫付业务需要用户申请，收派宝审核通过后方可使用该服务。
2.1.2 接口规则
(1)、接口指令CMD1004。
2.1.3 系统级输入参数
2.1.4 应用级输入参数
2.1.5 返回结果参数
2.1.6 JSON请求示例
{
"BankAccountNo": "62266226622662266226",
"BankAccountName": "hoo",
"BankName": "招商银行",
"BankBranch": "深圳深圳支行",
"BankCardPicA": "",
"BankCardPicB": ""
}
2.1.7 JSON返回示例
{
"Success": true,
"Message": "申请成功",
"RequestType": "cmd1004",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": ""
}
2.2 直退业务申请
2.2.1 功能说明
申请直退业务的权限。
2.2.2 接口规则
(1)、请求指令CMD1005。
2.2.3 系统级输入参数
2.2.4 应用级输入参数
2.2.5 返回结果参数
2.2.6 JSON请求示例
{
"BankAccountNo": "62266226622662266226",
"BankAccountName": "hoo",
"BankName": "招商银行",
"BankBranch": "深圳深圳支行",
"BankCardPicA": "",
"BankCardPicB": ""
}
2.2.7 JSON返回示例
{
"Success": true,
"Message": "申请成功",
"RequestType": "cmd1005",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": ""
}
2.3 普通代收货款申请
2.3.1 功能说明
申请普通代收货款业务的权限。
2.3.2 接口规则
(1)、请求指令CMD1006。
2.3.3 系统级输入参数
2.3.4 应用级输入参数
无
2.3.5 返回结果参数
2.3.6 JSON请求示例
{
"BankAccountNo": "62266226622662266226",
"BankAccountName": "hoo",
"BankName": "招商银行",
"BankBranch": "深圳深圳支行",
"BankCardPicA": "",
"BankCardPicB": ""
}
2.3.7 JSON返回示例
{
"Success": true,
"Message": "申请成功",
"RequestType": "cmd1006",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": ""
}
2.4 查询服务申请状态
2.4.1 功能说明
查询某用户的服务开通情况。
2.4.2 接口规则
(1)、请求指令CMD1007。
2.4.3 系统级输入参数
2.4.4 应用级输入参数
2.4.5 返回结果参数
2.4.6 JSON请求示例
{
"ServiceCode": "CODBACK"
}
2.4.7JSON返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1007",
"EBusinessID": "1261599",
"ResultCode": "100",
"Result": {
"UserGuid": "d07d687a-691a-45d9-82e0-e54aab076ed6",
"ServicesCode": "CODBACK",
"ServiceName": "货款直退",
"ValidDate": "",
"StartDate": "2017-01-09",
"Status": "1",
"Remark": "接口调用申请自动开通"
}
}
3订单类
下单
请通过《预约取件API》和《电子面单API》下单
3.2 获取订单货款状态
3.2.1 功能说明
获取订单货款状态。
3.2.2 接口规则
(1)、接口指令CMD1010。
3.2.3 系统级输入参数
3.2.4 应用级输入参数
3.2.5 返回结果参数
3.2.6 Json请求示例
{
"OrderNos": "",
"BeginTime": "",
"EndTime": "",
"PageIndex": "1",
"PageSize": "10"
}
3.2.7 Json请求返回示例
{
"Success": true,
"Message": "成功",
"RequestType": "cmd1010",
"EBusinessID": "1261644",
"ResultCode": "100",
"Result": {
"PageIndex": 1,
"PageSize": 10,
"TotalCount": 1,
"TotalPage": 1,
"ResultList": [
{
"OrderNo": "KF17021420473906248600",
" BillNo ":"444825646336",
"Status": 3,
" Amount ":310,
" CommisionAmount ":3.00
" OutTime ":"2017-02-14 20:48:44",
" BankAccountNo ":"622619061766805",
" BankAccountName ":"蒋",
" BankName ":"中国民生银行"
}
]
}
}
快递
航空货运
快运
铁路货运
国际海运
整车货运
跨境小包
即时配送
粤公安备案号：44030402002993
