Skip to content

Create Payin Order

Request URL

methodurl
POST/api/pay/payment/create/v1

Headers

Header ParameterDescription
timestampRequest timestamp
nonceRandom value
countryCountry code (CO)
app_codeApplication ID

Supported Payment Types (paymentType)

Payment Method NamePaymentType
PSE (Payment Online)201
NEQUI (WALLET)202
All (all in one checkoout)204
EFECTY (CASH)205

Request Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
paymentTypeIntyesPayment types, see list above
amountStringyes20Payin amount, integer only, in COP
expirationTimeLongnoExpiration timestamp
realNameStringyes64Userโ€™s full name
emailStringyes50Userโ€™s email (must match a valid regex format)
phoneStringyes50Phone number, 10 digits, no country code
idCardNumberStringno50ID number: CC 10 digits, CE 6โ€“10 digits, NIT 9 digits
signStringyesSignature
callbackUrlStringno200Callback URL
Request Example
{
"realName": "TeemoPay",
"amount": "10000",
"phone": "1234567890",
"callbackUrl": "https://www.callbackexample.com",
"merchantOrderNo": "OrderNoExample",
"email": "TeemoPay@example.com",
"paymentType": 204,
"sign": "YOUR_SIGN"
}

Response Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyes32Platform order number
amountStringyes32Transaction amount
paymentTypeIntyes3Payment type
paymentInfoStringyes32Main payment information, e.g., payment link or code
additionalInfoJSONObjectnoExtended information
statusIntyesPayment status: 1 = Success, 3 = Failure
errorMsgStringnoError message (returned only in case of failure)
Response Example
{
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610299",
"code": 200,
"data": {
"amount": "10000",
"tradeNo": "TS2501010001CO0000000000000000",
"merchantOrderNo": "OrderNoExample",
"paymentType": 204,
"additionalInfo": {
},
"paymentInfo": "https://www.paymentLinkExample.com",
"status": 1
}
}