跳转到内容

代付创建

API TEST CONSOLE

模拟请求

TEST ONLY

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

POST/trade/payout/create

请求鉴权

待配置

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

请求头

请求参数 application/json

响应结果

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

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

复制 cURL 不会发送请求

POST/trade/payout/create

请求头

公共请求头。

支付方式参数

payoutType
BANK
Wallet

请求参数

字段类型必填最大长度说明
merchantOrderNoString是32商户订单号
transactionAmountString是20代付金额(VND),仅支持整数
payoutTypeString是20代付方式
idTypeString是32证件类型:BRBANK
userIdCardString是32证件号码
userNameString是255用户姓名:传用户的真实姓与名
userPhoneString是50电话号码,以 0 开头的 10 位数字
userEmailString是50收款人邮箱,传用户的真实邮箱
bankCodeString是50银行编码,参考银行列表
bankNameString是50银行名称,参考银行列表
bankAccountNoString是32收款账号:传输用户真实收款账号信息
descriptionString否100说明
payoutCallbackUrlString否200代付回调地址

请求示例

以下示例用于展示字段结构;提交前请将 payoutType 和银行信息替换为商务确认的实际值。

{
"merchantOrderNo": "PAYOUT202609170001",
"transactionAmount": "100000",
"payoutType": "BANK",
"idType": "BRBANK",
"userIdCard": "012345678901",
"userName": "Nguyen Van A",
"userPhone": "0912345678",
"userEmail": "user@example.com",
"bankCode": "1043",
"bankName": "VCB",
"bankAccountNo": "1234567890",
"description": "Payout order",
"payoutCallbackUrl": "https://merchant.example/payout-callback"
}

响应参数

字段类型必填最大长度说明
codeint是-状态码,非 200 代表异常
dataObject是-响应体
data.merchantOrderNoString是32商户订单号
data.tradeNoString是32平台单号
data.transactionAmountString是-代付金额(VND),仅支持整数
data.statusString是24订单状态,创建时为 PAYING(支付中)或 FAIL(已失败)
data.payoutTypeString是24代付方式
msgString否-异常信息
tidString是-traceId

响应示例

{
"code": 200,
"data": {
"merchantOrderNo": "PAYOUT202609170001",
"tradeNo": "VF2405220001VN0000508467743993",
"transactionAmount": "100000",
"status": "PAYING",
"payoutType": "BANK"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}