跳转到内容

代收创建

API TEST CONSOLE

模拟请求

TEST ONLY

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

POST/trade/payment/create

请求鉴权

待配置

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

请求头

请求参数 application/json

响应结果

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

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

复制 cURL 不会发送请求

POST/trade/payment/create

请求头

公共请求头。

支付方式参数

paymentType
PSE
NEQUI_PSE
EFECTY
DAVIPLATA_PSE
TRANSFIYA
MOVIL_PSE
DALE_PSE
BREB_KEY
NEQUI_PUSH
BREB_QR
DAVIPLATA_PUSH

请求参数

字段类型必填最大长度说明
merchantOrderNoString是32商户订单号
transactionAmountString是20收款金额
paymentTypeString是24支付方式
idTypeString条件必填32paymentType 为 PSE 或 NEQUI_PSE 时必填;可选值:CC、CE、NIT、PA
userIdCardString条件必填50证件号码。paymentType 为 PSE 或 NEQUI_PSE 时必填;CC、CE 为 6~10 位数字;NIT 为 9 位数字;PA 为 9 位字母或数字
userNameString是64用户姓名
userPhoneString是10用户手机号码,10 位数字,以 3 开头
userEmailString是50用户邮箱
bankCodeString条件必填64银行编码;参考银行编码;paymentType 为 PSE 时必填
bankAccountNoString否64银行账户号
merchantNameString否64商户名称
descriptionString否100说明
expireTimeString否-订单过期时间(国家当地时间,格式 yyyy-MM-dd HH:mm:ss)
paymentCallbackUrlString否200代收回调地址

请求示例

{
"merchantOrderNo": "ORDER202609170001",
"transactionAmount": "100.00",
"paymentType": "PSE",
"idType": "CC",
"userIdCard": "1234567890",
"userName": "TEST USER",
"userPhone": "3001234567",
"userEmail": "user@example.com",
"bankCode": "1040",
"paymentCallbackUrl": "https://merchant.example/callback"
}

响应参数

字段类型必填最大长度说明
codeint是-状态码,非 200 代表异常
dataObject是-响应体
data.merchantOrderNoString是24商户订单号
data.tradeNoString是32平台单号
data.transactionAmountString是-收款金额,整数或保留 2 位小数
data.statusString是24订单状态
data.paymentTypeString是24支付方式
data.failMsgString否200订单失败原因
data.paymentInfoString否200支付信息
data.additionalObject否-附加信息
msgString否-异常信息
tidString是-traceId

响应示例

{
"code": 200,
"data": {
"merchantOrderNo": "ORDER202609170001",
"tradeNo": "VS2608270002CO0000000000040059",
"transactionAmount": "100.00",
"status": "PAYING",
"paymentType": "PSE",
"paymentInfo": "PAYMENT_INFORMATION"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}