Skip to content

Create pay-in

API TEST CONSOLE

Test request

TEST ONLY

Configure parameters and send a request to the test environment

POST/trade/payment/create

Authentication

Not configured

The private key is used only in your browser to generate authorization. It is never sent or stored.

Request headers

Request body application/json

Response

Response
After you send the request, the status, duration, and JSON response appear here.

Authentication details remain only in this page's memory and are not written to local storage.

Copying cURL does not send a request

POST/trade/payment/create

Request headers

Common request headers.

Payment method values

paymentType
CHECKOUT
QR
PHONEPE
PAYTM

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
transactionAmountStringYes20Pay-in amount
paymentTypeStringYes24Payment method
idTypeStringNo32Optional ID type. This endpoint has no fixed enum; omit this field unless required by your business or payment channel.
userIdCardStringNo50ID number. No fixed format; omit this field unless required by your business or payment channel.
userNameStringYes64User name
userPhoneStringYes10User mobile number, 10 digits; starts with 6, 7, 8 or 9
userEmailStringYes50User email
bankCodeStringNo64Bank codes
bankAccountNoStringNo64Bank account number
merchantNameStringNo64Merchant name
descriptionStringNo100Description
expireTimeStringNo-Order expiration time (local time, format yyyy-MM-dd HH:mm:ss)
paymentCallbackUrlStringNo200Pay-in callback URL

Request example

{
"merchantOrderNo": "ORDER202609170001",
"transactionAmount": "100.00",
"paymentType": "CHECKOUT",
"userName": "TEST USER",
"userPhone": "6123456789",
"userEmail": "user@example.com",
"paymentCallbackUrl": "https://merchant.example/callback"
}

Response parameters

FieldTypeRequiredMaximum lengthDescription
codeintYes-Status code; a value other than 200 indicates an error
dataObjectYes-Response body
data.merchantOrderNoStringYes24Merchant order number
data.tradeNoStringYes32Platform order number
data.transactionAmountStringYes-Pay-in amount, an integer or up to two decimal places
data.statusStringYes24Order status
data.paymentTypeStringYes24Payment method
data.failMsgStringNo200Order failure reason
data.paymentInfoStringNo200Payment information
data.additionalObjectNo-Additional information
msgStringNo-Error message
tidStringYes-Trace ID

Response example

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