Skip to content

Create Cashier

Request URL

methodurl
POST/api/checkout/payment/create

Headers

Header ParameterDescription
timestampRequest timestamp
nonceRandom value
countryMX
appCodeApplication ID

Request Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
paymentTypeIntnoPayment method. 1:VA 4:PayCashOnce 5:PayCashRecurrent 6:OXXO
expirationTimeStringnoThe default is 1day; the shortest time is 10 minutes and the longest is 20 days; Xm: minutes (such as 90m for 90 minutes), Xh: hours (such as 2h for 2 hours), Xd: days (such as 5d for 5 days)
amountStringyes20Amount, positive integer
phoneStringno10Phone number
emailStringno50User email
callbackUrlStringno200Callback URL
signStringyesSignature
request
{
"merchantOrderNo": "OrderNoExample",
"amount": "1000",
"callbackUrl": "https://www.callbackexample.com",
"sign": "YOUR_SIGN"
}

Response Parameters

ParameterTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
amountStringyesOrder transaction amount
statusIntyesCollection status: 0 = processing, 3 = failed
checkoutLinkStringnoCheckout page URL
expirationTimeStringnoCheckout page expiration time
errorMsgStringnoError message, returned when failed
response
{
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610299",
"code": 200,
"data": {
"amount": "1000.00",
"tradeNo": "TS2501010001MX0000000000000000",
"expirationTime": "2025-01-01 00:00:00",
"checkoutLink": "https://mx-payin.teemopay.com/#/?tradeNo=TS2501010001MX0000000000000000",
"merchantOrderNo": "OrderNoExample",
"status": 0
}
}