跳转到内容

代收创建

API TEST CONSOLE

模拟请求

TEST ONLY

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

POST/trade/payment/create

请求鉴权

待配置

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

请求头

请求参数 application/json

响应结果

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

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

复制 cURL 不会发送请求

POST/trade/payment/create

请求头

公共请求头。

支付方式参数

paymentType
QR
VA

请求参数

字段类型必填最大长度说明
merchantOrderNoString是32商户订单号
transactionAmountString是20代收金额(VND),仅支持整数
paymentTypeString是24支付方式
idTypeString否32可选的证件类型;当前接口没有固定枚举,无业务或渠道要求时可不传
userIdCardString否50证件号码。无固定格式,无业务或渠道要求时可不传
userNameString是64付款人姓名
userPhoneString是50电话号码,以 0 开头的 10 位数字
userEmailString是50付款人邮箱,须符合有效邮箱的正则格式
bankCodeString条件必填50银行编码,参考银行列表;paymentType 为 VA 时必填
bankAccountNoString否64银行账户号
merchantNameString否64收款人名称
descriptionString否100说明
expireTimeString否-订单过期时间(国家当地时间,格式 yyyy-MM-dd HH:mm:ss)
paymentCallbackUrlString否200代收回调地址

请求示例

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

{
"merchantOrderNo": "ORDER202609170001",
"transactionAmount": "100000",
"paymentType": "QR",
"idType": "NATIONAL_ID",
"userIdCard": "012345678901",
"userName": "TEST USER",
"userPhone": "0912345678",
"userEmail": "user@example.com",
"bankCode": "1001",
"bankAccountNo": "1234567890",
"merchantName": "TEST MERCHANT",
"description": "Payment order",
"expireTime": "2026-09-21 18:00:00",
"paymentCallbackUrl": "https://merchant.example/callback"
}

VA 请求示例(必须传入 bankCode):

{
"merchantOrderNo": "ORDER202609170002",
"transactionAmount": "100000",
"paymentType": "VA",
"userName": "TEST USER",
"userPhone": "0912345678",
"userEmail": "user@example.com",
"bankCode": "1001",
"paymentCallbackUrl": "https://merchant.example/callback"
}

响应参数

字段类型必填最大长度说明
codeint是-状态码,非 200 代表异常
dataObject是-响应体
data.merchantOrderNoString是32商户订单号
data.tradeNoString是32平台单号
data.transactionAmountString是-代收金额(VND),仅支持整数
data.statusString是24订单状态,创建时为 PAYING(支付中)或 FAIL(已失败)
data.paymentTypeString是24支付方式
data.failMsgString否200订单失败原因,失败时返回
data.paymentInfoString是200主要付款信息:QR 返回二维码支付 QrCode 串;VA 返回 VA 账号
data.additionalObject否-附加付款信息:paymentLink(String,必填)为支付链接;qrString(String,必填)为 QR 的二维码支付 QrCode 串;va(String,必填)为 VA 账号
msgString否-异常信息
tidString是-traceId

响应示例

{
"code": 200,
"data": {
"merchantOrderNo": "ORDER202609170001",
"tradeNo": "VS2608270002VN0000000000040059",
"transactionAmount": "100000",
"status": "PAYING",
"paymentType": "QR",
"paymentInfo": "QR_CODE_STRING_EXAMPLE",
"additional": {
"paymentLink": "https://example.com/pay",
"qrString": "QR_CODE_STRING_EXAMPLE",
"va": "1234567890123"
}
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}