收银台创建
POST
/trade/checkout/create请求头
支付方式参数
paymentType |
|---|
PSE |
NEQUI_PSE |
EFECTY |
DAVIPLATA_PSE |
TRANSFIYA |
MOVIL_PSE |
DALE_PSE |
BREB_KEY |
NEQUI_PUSH |
BREB_QR |
DAVIPLATA_PUSH |
请求参数
| 字段 | 类型 | 必填 | 最大长度 | 说明 |
|---|---|---|---|---|
merchantOrderNo | String | 是 | 32 | 商户订单号 |
transactionAmount | String | 是 | 20 | 收款金额,整数(保留 2 位小数) |
paymentType | String | 否 | 32 | 支付方式 |
idType | String | 否 | 32 | 证件类型:CC、CE、NIT、PA |
userIdCard | String | 否 | 50 | 证件号码。CC、CE 为 6~10 位数字;NIT 为 9 位数字;PA 为 9 位字母或数字 |
userName | String | 否 | 64 | 用户姓名 |
userPhone | String | 否 | 10 | 用户手机号码,10 位数字,以 3 开头 |
userEmail | String | 否 | 50 | 用户邮箱 |
expireTime | String | 否 | - | 订单过期时间(国家当地时间) |
description | String | 否 | 100 | 说明 |
paymentCallbackUrl | String | 否 | 200 | 代收回调地址 |
请求示例
{ "merchantOrderNo": "CHECKOUT202609170001", "transactionAmount": "100.00", "paymentType": "PSE", "userPhone": "3000000000", "description": "Test checkout", "paymentCallbackUrl": "https://merchant.example/callback"}响应参数
| 字段 | 类型 | 必填 | 最大长度 | 说明 |
|---|---|---|---|---|
code | int | 是 | - | 状态码,非 200 代表异常 |
data | Object | 是 | - | 响应体 |
data.merchantOrderNo | String | 是 | 32 | 商户订单号 |
data.tradeNo | String | 是 | 32 | 平台单号 |
data.transactionAmount | String | 是 | 20 | 收款金额 |
data.status | String | 是 | 20 | 订单状态 |
data.expireTime | String | 是 | - | 过期时间(国家当地时间) |
data.paymentLink | String | 是 | 24 | 支付链接 |
data.failMsg | String | 否 | 200 | 订单失败原因 |
msg | String | 否 | - | 异常信息 |
tid | String | 是 | - | traceId |
响应示例
{ "code": 200, "data": { "merchantOrderNo": "CHECKOUT202609170001", "tradeNo": "VS2608270002CO0000000000040059", "transactionAmount": "100.00", "status": "PAYING", "expireTime": "2026-09-17 16:30:00", "paymentLink": "https://test-co-payin.vellpay.com/VS2609180004CO0000000000004065" }, "msg": "success", "tid": "747bbf80261844ed85b809212aab0d81"}