快遞鳥一次性對接600+物流接口

首頁 > API文檔 > 代收貨款API
代收貨款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元封頂
EMS3萬簽收後每週二、四 16:001%
貨款墊付龍邦300012點前發件,當天16前;
12點後發件,第2個工作日11點前
每筆2元
快遞公司服務範圍
支持公司定義
順豐深圳-全國
8000個支持網點
龍邦廣東省-廣東省
300個支持網點
圓通全國-全國
10000個支持網點
速騰廣東省-廣東省
250個支持網點
京廣廣東省-廣東省
240個支持網點
韻達全國-全國
7000個支持網點
EMS深圳市-全國
72個支持網點
使用流程
COD
貨款直退/貨款墊付
業務流程
COD
貨款直退
貨款墊付
API參數
1用户信息類
1.1用户註冊接口
1.1.1功能説明
為第三方平台用户提供註冊接口,方便平台用户接入快遞鳥服務,同時也方便快遞鳥為平台用户提供查詢、訂閲、下單、金融等全方位物流服務。
1.1.2接口規則
(1)、接口只支持Json格式參數,接口指令9001。只支持POST請求方式,utf-8編碼。
(2)、測試地址://testapi.kdniao.com:8081/api/reg
(3)、正式地址://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": "//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)、測試地址://testapi.kdniao.com:8081/api/agencyfund
(3)、正式地址://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 ":"中國民生銀行"                      }                      ]                      }                      }
接入流程
demo下載

相關文檔與更多幫助?

30萬+
數十萬客户的選擇
5.8億次+
日均處理物流數據次數
1450萬+
日均千萬訂單數據處理
600家+
支持全國600+家物流商
在線諮詢
商務合作羣:
1054978381
技術對接羣11:
844089794
400-9633-321
免費獲取API