代付创建
POST
/trade/payout/create请求头
支付方式参数
payoutType |
|---|
CPF |
CNPJ |
PHONE |
EMAIL |
EVP |
请求参数
| 字段 | 类型 | 必填 | 最大长度 | 说明 |
|---|---|---|---|---|
merchantOrderNo | String | 是 | 32 | 商户订单号 |
transactionAmount | String | 是 | 20 | 付款金额,整数(保留 2 位小数) |
payoutType | String | 是 | 20 | 代付方式 |
idType | String | 是 | 50 | 证件类型:个人使用 CPF,企业使用 CNPJ |
userIdCard | String | 是 | 50 | 证件号码。CPF 为 11 位数字;CNPJ 为 14 位数字;仅传数字 |
userName | String | 是 | 64 | 用户姓名 |
userPhone | String | 否 | 11 | 用户手机号码,11 位数字(2 位地区码 + 9 位号码) |
userEmail | String | 否 | 50 | 用户邮箱 |
bankCode | String | 否 | 20 | 银行编码 |
bankName | String | 否 | - | 银行名称 |
bankAccountNo | String | 是 | 50 | 收款账户 |
description | String | 否 | 100 | 说明 |
payoutCallbackUrl | String | 否 | 200 | 代付回调地址 |
请求示例
{ "merchantOrderNo": "PAYOUT202609170001", "transactionAmount": "100.00", "payoutType": "CPF", "idType": "CPF", "userIdCard": "12345678901", "userName": "TEST USER", "userPhone": "11987654321", "bankName": "Banco do Brasil", "bankAccountNo": "12345678901"}响应参数
| 字段 | 类型 | 必填 | 最大长度 | 说明 |
|---|---|---|---|---|
code | int | 是 | - | 状态码,非 200 代表异常 |
data | Object | 是 | - | 响应体 |
data.merchantOrderNo | String | 是 | 32 | 商户订单号 |
data.tradeNo | String | 是 | 32 | 平台单号 |
data.transactionAmount | String | 是 | - | 付款金额 |
data.status | String | 是 | 24 | 订单状态 |
data.payoutType | String | 是 | 24 | 代付方式 |
msg | String | 否 | - | 异常信息 |
tid | String | 是 | - | traceId |
响应示例
{ "code": 200, "data": { "merchantOrderNo": "PAYOUT202609170001", "tradeNo": "VF2405220001BR0000508467743993", "transactionAmount": "100.00", "status": "PAYING", "payoutType": "CPF" }, "msg": "success", "tid": "747bbf80261844ed85b809212aab0d81"}