跳转到内容

代付创建

API TEST CONSOLE

模拟请求

TEST ONLY

测试环境下配置参数并发送请求

POST/trade/payout/create

请求鉴权

待配置

私钥仅在浏览器内用于生成 authorization,不会随请求发送或保存

请求头

请求参数 application/json

响应结果

Response
发送请求后,响应状态、耗时和 JSON 将显示在这里。

认证信息仅保留在当前页面内存中,不会写入本地存储。

复制 cURL 不会发送请求

POST/trade/payout/create

请求头

公共请求头。

支付方式参数

payoutType
AHORRO
CORRIENTE
PHONE
BREB

请求参数

字段类型必填最大长度说明
merchantOrderNoString是32商户订单号
transactionAmountString是20付款金额,整数(保留 2 位小数)
payoutTypeString是20代付方式
idTypeString是32证件类型:CC、CE、NIT、PA
userIdCardString是50证件号码。CC、CE 为 6~10 位数字;NIT 为 9 位数字;PA 为 9 位字母或数字
userNameString是64用户姓名
userPhoneString是10用户手机号码,10 位数字,以 3 开头
userEmailString是50用户邮箱
bankCodeString是20银行编码
bankNameString是50银行名称
bankAccountNoString是255收款账户。payoutType 为 BREB 时按键类型传值:PHONE 为无前缀、以 3 开头的固定 10 位数字;EMAIL 为 6~255 位标准邮箱;DOCUMENT 为 6~12 位数字;NIT 为 9~10 位数字;ALIAS 以 @ 开头,后接 3~30 位字母或数字
descriptionString否100说明
payoutCallbackUrlString否200代付回调地址

请求示例

{
"merchantOrderNo": "PAYOUT202609170001",
"transactionAmount": "100.00",
"payoutType": "AHORRO",
"idType": "CC",
"userIdCard": "1234567890",
"userName": "TEST USER",
"userPhone": "3001234567",
"userEmail": "user@example.com",
"bankCode": "1007",
"bankName": "BANCOLOMBIA",
"bankAccountNo": "1234567890"
}

响应参数

字段类型必填最大长度说明
codeint是-状态码,非 200 代表异常
dataObject是-响应体
data.merchantOrderNoString是32商户订单号
data.tradeNoString是32平台单号
data.transactionAmountString是-付款金额
data.statusString是24订单状态
data.payoutTypeString是24代付方式
msgString否-异常信息
tidString是-traceId

响应示例

{
"code": 200,
"data": {
"merchantOrderNo": "PAYOUT202609170001",
"tradeNo": "VF2405220001CO0000508467743993",
"transactionAmount": "100.00",
"status": "PAYING",
"payoutType": "AHORRO"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}