# 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格式应该是09开头手机号格式
accountName string 1-30 - 收款人姓名 格式:英文大小写且允许有空格,1-30位,"firstName middleName lastName" (middleName 非必填, 特殊字符支持 '.-)
payMethodCode string - - PayCools代付类型
bankCode 是 - payMethodCode是BANK的话必传 string - - 收款银行名称(简)
ewalletCode 是 - payMethodCode是EWALLET的话必传 string - - 收款电子钱包名称(简)
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 签名
# 响应参数
参数名 类型 示例 说明
code int 1000 状态码, 参考列表
message String success 状态码信息
data Object - 返回具体信息
- transactionId String D1036653581161279102 paycools系统订单号,Paycools系统唯一标识
- transactionStatus String PENDING 订单交易状态
- transactionTime String 2022-05-24 12:51:07 交易创建时间
# payMethodCode, bankCode, ewalletCode 参考此列表
# 返回示例
{
	"code":1000,
	"message":"success",
	"data":{
		"transactionId":"D1036653581161279102",
		"transactionStatus":"PENDING",
		"transactionTime":"2022-05-24 12:51:07"
	}
}
# 返回失败案例 code参考列表 参考列表
{
    "code":1002,
    "message":"merchant white ip forbidden",
}