Create pay-in
POST
/trade/payment/createRequest headers
Payment method values
paymentType |
|---|
PIX |
Request parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
merchantOrderNo | String | Yes | 32 | Merchant order number |
transactionAmount | String | Yes | 20 | Pay-in amount |
paymentType | String | Yes | 24 | Payment method |
idType | String | No | 32 | User ID type: individual uses CPF, business uses CNPJ |
userIdCard | String | No | 50 | ID number. CPF contains 11 digits and CNPJ contains 14 digits; omit dots, slashes, and hyphens. |
userName | String | No | 64 | User name |
userPhone | String | No | 11 | User mobile number, 11 digits (2 digit area code + 9 digit subscriber number) |
userEmail | String | No | 50 | User email |
bankCode | String | No | 64 | Bank codes |
bankAccountNo | String | No | 64 | Bank account number |
merchantName | String | No | 64 | Merchant name |
description | String | No | 100 | Description |
expireTime | String | No | - | Order expiration time (local time, format yyyy-MM-dd HH:mm:ss) |
paymentCallbackUrl | String | No | 200 | Pay-in callback URL |
Request example
{ "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"}Response parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
code | int | Yes | - | Status code; a value other than 200 indicates an error |
data | Object | Yes | - | Response body |
data.merchantOrderNo | String | Yes | 24 | Merchant order number |
data.tradeNo | String | Yes | 32 | Platform order number |
data.transactionAmount | String | Yes | - | Pay-in amount, an integer or up to two decimal places |
data.status | String | Yes | 24 | Order status |
data.paymentType | String | Yes | 24 | Payment method |
data.failMsg | String | No | 200 | Order failure reason |
data.paymentInfo | String | No | 200 | Payment information |
data.additional | Object | No | - | Additional information |
msg | String | No | - | Error message |
tid | String | Yes | - | Trace ID |
Response example
{ "code": 200, "data": { "merchantOrderNo": "ORDER202609170001", "tradeNo": "VS2608270002BR0000000000040059", "transactionAmount": "100.00", "status": "PAYING", "paymentType": "PIX", "paymentInfo": "PAYMENT_INFORMATION" }, "msg": "success", "tid": "747bbf80261844ed85b809212aab0d81"}