API Doc

# 1. 代付下单接口

# 简要描述

  • 商户代付-下单接口

# 请求URL

  • /api/v1/payout

# 请求方式

  • POST

# 请求头

参数名 必选 类型 说明
Content-Type mandatory string application/json

# 请求参数

参数名 必选 类型 长度限制 示例 说明
appId 是 string - - 应用APPID
mchOrderId 是 string 1-32 CCP20220428011068111 商户订单id，格式：字母+数字, 1-32位
appName 是 string 1-100 - 商户对接应用名称, 格式：字母+空格，1-100位
idempotencyId 是 string 10-30 - 幂等式校验KEY, 格式：字母+数字，10-30位
amount 是 int 100-500000000 50000 代付金额，单位：分 例如PHP:500.10, 需要设置50010分
accountNo 是 string - - 收款人账号:如果是是电子钱包,accountNo
accountName 是 string 1-30 - 收款人姓名 格式：英文大小写且允许有空格，1-30位,"firstName middleName lastName" (middleName 非必填, 特殊字符支持 '.-)
payMethodCode 是 string - - PayCools代付类型，传递 EWALLET
bankCode 是 - payMethodCode是BANK的话必传 string - - 收款银行名称(简)
ewalletCode 是 - payMethodCode是EWALLET的话必传 string - - 收款电子钱包名称(简)，传递 JT
remark 否 string 1-200 - 代付备注
idCardPicUrl 否 string 1-200 - 用户身份证件图片url
idCardExpiryDate 否 string 1-20 2022-05-26 用户身份证件过期日期 format: yyyy-MM-dd
birthPlace 否 string 1-200 - 用户出生地
gender 否 int 2 1 用户性别 男：1；女：0；其他：2
email 否 string 1-50 - 用户邮箱
sign 是 string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 签名

# 请求示例

{
    "appId": "c35353bd69834040af5c3ed45f326d83",
    "mchOrderId": "Payout123456789789",
    "appName": "Test",
    "idempotencyId": "Payout123456789789",
    "amount": 100000,
    "accountNo": "09123456789",
    "accountName": "Test",
    "payMethodCode": "EWALLET",
    "ewalletCode": "JT",
    "remark": "remark",
    "sign": "45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892"
}

# 响应参数

参数名 类型 说明
code int 状态码
message string 状态描述
data object 响应数据

# data参数

参数名 类型 示例 说明
transactionId String D1036653581161279102 paycools系统订单号，Paycools系统唯一标识
transactionStatus String PENDING 订单交易状态
transactionTime String 2022-05-24 12:51:07 交易创建时间

# 返回示例

{
  "code": 1000,
  "message": "success",
  "data": {
    "transactionId": "D1036653581161279102",
    "transactionStatus": "PENDING",
    "transactionTime": "2022-05-24 12:51:07"
  }
}

# 返回失败案例 code参考列表 参考列表

{
  "code": 1002,
  "message": "merchant white ip forbidden"
}

← 2. 查询代付状态接口 →