快货运Open Api

# 新增收款账户

接口名称： /payee/create

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 name 开户姓名 String 20 是 2-20 个字符，只允许汉字+少数民族符号 ·
2 1 idCard 身份证号码 String 18 是 18 位数字（末尾允许输入 X），符合身份证号校验算法
3 1 phone 手机号码 String 20 否 传入号码需符合手机号码格式校验
4 1 type 收款账户类型 Integer 1 否 不填默认为1-银行账户
1-银行账户 4-支付宝 5-微信 6-第三方支付 7-其他电子支付
5 1 bankCardNumber 账户号码 String 50 是 1-50 位数字
type为1-银行卡时，输入银行卡号
type为4-支付宝 5-微信 6-第三方支付 7-其他电子支付时，可输入大小写字母数字及特殊符号()/=+?!*;@#:%${}
6 1 bankDeposit 开户银行 String 64 是 type为银行卡时：参看《银行列表》，传入对应名称
type为支付宝、 微信、 第三方支付 、其他电子支付时 ，开户银行传入“其他”

示例

{
  "bankCardNumber": "string",
  "bankDeposit": "string",
  "idCard": "string",
  "name": "string",
  "phone": "string",
  "type": "1"
}

返回参数

类型 名称 备注
Integer code 返回码 200
String message 返回信息
String data

mock 数据示例 { "code": "00000", "message": "调用成功"， "data": true }

错误码

# 更新收款账户

接口名称：/payee/update

请求参数

序号 层级 英文名称 中文名称 类型 长度 是否必填 说明
1 1 name 开户姓名 String 20 是 2-20 个字符，只允许汉字+少数民族符号 ·
2 1 bankCardNumber 账户号码 String 20 是 13-21 位数字
3 1 phone 新手机号码 String 64 否 传入号码需符合手机号码格式校验
4 1 type 收款账户类型 Integer 1 否 不填默认为1-银行账户
1-银行账户 4-支付宝 5-微信 6-第三方支付 7-其他电子支付
5 1 newBankCardNumber 新账户号码 string 50 否 type 为 4-支付宝 5-微信 6-第三方支付 7-其他电子支付类型时，支持修改账户号码。

示例

{
  "bankCardNumber": "string",
  "name": "string",
  "phone": "string",
  "type": "4",
  "newBankCardNumber": "string"
}

返回参数

类型 名称 备注
Integer code 返回码 200
String message 返回信息
String data

mock 数据示例

{
    "code": "00000",
    "message": "调用成功"，
    "data": true
}

# 查询收款账户信息

接口名称：/payee/search

请求参数

序号 层级 英文名称 中文名称 类型 长度 必填 说明
1 1 bankCardNumberList 账户号码 [String] 否
2 1 idCardList 身份证号 [String] 否

请求参数示例

{
  "bankCardNumberList": ["string"],
  "idCardList": ["string"]
}

返回参数

序号 层级 英文名称 中文名称 类型
1 1 id 主键 id Long
2 name 开户姓名 String
3 1 idCard 身份证号码 String
4 1 type 账户类型：1-银行账户 2-虚拟账户4-支付宝 5-微信 6-第三方支付 7-其他电子支付 Integer
5 1 bankCardNumber 账户号码 String
6 1 accountNo 账户号（支付系统生成的账号) String
7 1 bankCode 银行 code String
8 1 freightCode 网络货运端 code String
9 bankDeposit 开户银行 String
10 1 remark 备注 String

mock 数据示例

{
  "code": "00000",
  "data": [
    {
      "accountNo": "string",
      "bankCardNumber": "string",
      "bankCode": "string",
      "bankDeposit": "string",
      "freightCode": "string",
      "id": 0,
      "idCard": "string",
      "name": "string",
      "phone": "string",
      "remark": "string",
      "type": 1
    }
  ],
  "message": "string"
}

← 承运合同 →