Skip to main content

Create Deposit Order (Mexico)

API for creating Mexican Peso (MXN) deposit orders.

Request Information​

  • Request URL: /gateway/api/v2/payments
  • Method: POST
  • Content-Type: application/json;charset=utf-8

Request Parameters​

ParameterRequiredTypeDescription
platform_idYesString(6)Merchant ID
service_idYesString(7)Service ID, fixed value SVC0122
payment_cl_idYesString(64)Merchant Order ID
amountYesInteger(10)Amount (in cents, centavos)
notify_urlYesString(256)Callback URL for transaction results
nameNoString(64)Payer name (recommended, see Remarks)
request_timeYesInteger(10)Request time (seconds)
sign_typeNoString(16)Signature type, fixed value HMAC-SHA256
signYesString(32|64)Order Signature

Service ID​

  • SVC0122 SPEI Bank Transfer (Mexico Channel)

Response Example​

Successful Response​

{
"error_code": "0000",
"data": {
"link": "https://pay.example.com/cashier/DEMOPM0123456",
"payment_id": "DEMOPM0123456",
"payment_cl_id": "order_20260112001",
"amount": 50000,
"card_name": "DEMO ACCOUNT",
"card_number": "002010077777777771",
"bank_name": "DEMO BANK",
"payment_cl_name": "JUAN PEREZ"
}
}

Response Parameters​

ParameterTypeDescription
error_codeStringError code, see Global Error Codes
error_msgStringError message (returned when error_code is not "0000")
linkStringCashier page URL
payment_idStringPlatform Order ID
payment_cl_idStringMerchant Order ID
amountIntOrder amount
card_nameStringReceiving account name
card_numberStringReceiving account number (18-digit CLABE)
bank_nameStringReceiving bank name
payment_cl_nameStringPayer name, echoed back from the name passed at order creation

Remarks​

  • Transaction amount is in Mexican Peso (cents, centavos), please multiply by 100 before sending, e.g. pass 50000 for 500.00 MXN
  • The payer must pay by SPEI transfer to the returned receiving account (18-digit CLABE); each order gets its own dedicated receiving account, so no transfer reference is needed
  • We recommend passing name (payer name) when creating the order; this service requires a payer name, so if the merchant omits it, the payer will first be redirected to a transit page to fill it in before the original payment flow continues. In that case the creation response does not contain the receiving account details (card_name / card_number / bank_name); direct the payer to link
  • After obtaining link, you may direct the payer to the cashier page, which displays the receiving account details
  • Request time uses Unix timestamp, in seconds
  • Transaction results will be sent to notify_url; the URL must be publicly reachable (http/https only), see Deposit Notification for parameter details
  • The final order status must be taken from Query Deposit Order or the transaction notification