代收创建
POST
/trade/payment/create请求头
支付方式参数
paymentType |
|---|
PIX |
请求参数
| 字段 | 类型 | 必填 | 最大长度 | 说明 |
|---|---|---|---|---|
merchantOrderNo | String | 是 | 32 | 商户订单号 |
transactionAmount | String | 是 | 20 | 收款金额 |
paymentType | String | 是 | 24 | 支付方式 |
idType | String | 否 | 32 | 用户证件类型:个人使用 CPF,企业使用 CNPJ |
userIdCard | String | 否 | 50 | 证件号码。CPF 为 11 位数字;CNPJ 为 14 位数字;不包含点、斜线或连字符 |
userName | String | 否 | 64 | 用户姓名 |
userPhone | String | 否 | 11 | 用户手机号码,11 位数字(2 位地区码 + 9 位号码) |
userEmail | String | 否 | 50 | 用户邮箱 |
bankCode | String | 否 | 64 | 银行编码 |
bankAccountNo | String | 否 | 64 | 银行账户号 |
merchantName | String | 否 | 64 | 商户名称 |
description | String | 否 | 100 | 说明 |
expireTime | String | 否 | - | 订单过期时间(国家当地时间,格式 yyyy-MM-dd HH:mm:ss) |
paymentCallbackUrl | String | 否 | 200 | 代收回调地址 |
请求示例
{ "merchantOrderNo": "ORDER202609170001", "transactionAmount": "100.00", "paymentType": "PIX", "idType": "CPF", "userIdCard": "12345678901", "userName": "TEST USER", "userPhone": "11987654321", "userEmail": "user@example.com", "bankCode": "001", "bankAccountNo": "1234567890", "merchantName": "TEST MERCHANT", "description": "Payment order", "expireTime": "2026-09-21 18:00:00", "paymentCallbackUrl": "https://merchant.example/callback"}响应参数
| 字段 | 类型 | 必填 | 最大长度 | 说明 |
|---|---|---|---|---|
code | int | 是 | - | 状态码,非 200 代表异常 |
data | Object | 是 | - | 响应体 |
data.merchantOrderNo | String | 是 | 24 | 商户订单号 |
data.tradeNo | String | 是 | 32 | 平台单号 |
data.transactionAmount | String | 是 | - | 收款金额,整数或保留 2 位小数 |
data.status | String | 是 | 24 | 订单状态 |
data.paymentType | String | 是 | 24 | 支付方式 |
data.failMsg | String | 否 | 200 | 订单失败原因 |
data.paymentInfo | String | 否 | 200 | 支付信息 |
data.additional | Object | 否 | - | 附加信息 |
msg | String | 否 | - | 异常信息 |
tid | String | 是 | - | traceId |
响应示例
{ "code": 200, "data": { "merchantOrderNo": "ORDER202609170001", "tradeNo": "VS2608270002BR0000000000040059", "transactionAmount": "100.00", "status": "PAYING", "paymentType": "PIX", "paymentInfo": "PAYMENT_INFORMATION" }, "msg": "success", "tid": "747bbf80261844ed85b809212aab0d81"}