Skip to content

Create checkout

API TEST CONSOLE

Test request

TEST ONLY

Configure parameters and send a request to the test environment

POST/trade/checkout/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/checkout/create

Request headers

Common request headers.

Payment method values

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

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
transactionAmountStringYes20Pay-in amount, an integer or up to two decimal places
paymentTypeStringNo32Payment method
idTypeStringNo32ID type: CC, CE, NIT, PA
userIdCardStringNo50ID number. CC and CE contain 6–10 digits; NIT contains 9 digits; PA contains 9 letters or digits.
userNameStringNo64User name
userPhoneStringNo10User mobile number, 10 digits; starts with 3
userEmailStringNo50User email
expireTimeStringNo-Order expiration time (local time)
descriptionStringNo100Description
paymentCallbackUrlStringNo200Pay-in callback URL

Request example

{
"merchantOrderNo": "CHECKOUT202609170001",
"transactionAmount": "100.00",
"paymentType": "PSE",
"userPhone": "3000000000",
"description": "Test checkout",
"paymentCallbackUrl": "https://merchant.example/callback"
}

Response parameters

FieldTypeRequiredMaximum lengthDescription
codeintYes-Status code; a value other than 200 indicates an error
dataObjectYes-Response body
data.merchantOrderNoStringYes32Merchant order number
data.tradeNoStringYes32Platform order number
data.transactionAmountStringYes20Pay-in amount
data.statusStringYes20Order status
data.expireTimeStringYes-Expiration time (local time)
data.paymentLinkStringYes24Payment link
data.failMsgStringNo200Order failure reason
msgStringNo-Error message
tidStringYes-Trace ID

Response example

{
"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"
}