Create Payin Order
Request URL
| method | url |
|---|---|
| POST | /api/pay/payment/create/v1 |
Headers
| Header Parameter | Description |
|---|---|
| timestamp | Request timestamp |
| nonce | Random value |
| country | Country code (CO) |
| app_code | Application ID |
Supported Payment Types (paymentType)
| Payment Method Name | PaymentType |
|---|---|
| PSE (Payment Online) | 201 |
| NEQUI (WALLET) | 202 |
| All (all in one checkoout) | 204 |
| EFECTY (CASH) | 205 |
Request Parameters
| Field | Type | Required | Length | Description |
|---|---|---|---|---|
| merchantOrderNo | String | yes | 32 | Merchant order number |
| paymentType | Int | yes | Payment types, see list above | |
| amount | String | yes | 20 | Payin amount, integer only, in COP |
| expirationTime | Long | no | Expiration timestamp | |
| realName | String | yes | 64 | Userโs full name |
| String | yes | 50 | Userโs email (must match a valid regex format) | |
| phone | String | yes | 50 | Phone number, 10 digits, no country code |
| idCardNumber | String | no | 50 | ID number: CC 10 digits, CE 6โ10 digits, NIT 9 digits |
| sign | String | yes | Signature | |
| callbackUrl | String | no | 200 | Callback URL |
{
"realName": "TeemoPay", "amount": "10000", "phone": "1234567890", "callbackUrl": "https://www.callbackexample.com", "merchantOrderNo": "OrderNoExample", "email": "TeemoPay@example.com", "paymentType": 204, "sign": "YOUR_SIGN"
}Response Parameters
| Field | Type | Required | Length | Description |
|---|---|---|---|---|
| merchantOrderNo | String | yes | 32 | Merchant order number |
| tradeNo | String | yes | 32 | Platform order number |
| amount | String | yes | 32 | Transaction amount |
| paymentType | Int | yes | 3 | Payment type |
| paymentInfo | String | yes | 32 | Main payment information, e.g., payment link or code |
| additionalInfo | JSONObject | no | Extended information | |
| status | Int | yes | Payment status: 1 = Success, 3 = Failure | |
| errorMsg | String | no | Error message (returned only in case of failure) |
{
"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 }}