Mexico Payment API

About 1212 wordsAbout 4 min

Warning

Before reading this API document, please make sure to check API Description Guide

Disbursement API

Disbursement Application

Brief Description:

Create a disbursement order

URL: /mxn/pay/apply
Note: appId MXN, amount MXN, settlement MXN.

Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (retrieved from the backend, must match the currency in the URL).
orderId	Yes	String	Merchant Order ID (must be unique, max length 48).
amount	Yes	String	Transaction amount (unit: Mex$, accurate to two decimal places; commas or other symbols are prohibited).
accountType	Yes	String	Account type: BANK_CARD (Clabe, 18 digits), BANK_ACCOUNT (Debit Card, 16 digits).
bankCode	Yes	String	Bank code or wallet code. See Bank Codes.
accountNo	Yes	String	User bank account number.
name	Yes	String	Recipient name (format: upper/lowercase letters, spaces allowed, 1-30 chars, `"firstName middleName lastName"`; middleName optional, supports '.-).
phone	Yes	String	Valid phone number (see Phone Number Format).
email	Yes	String	Valid email address.
notifyUrl	No	String	Callback URL.
subject	No	String	Payment note (transaction title, product name, reason for payment).
body	No	String	Additional details.
partnerUserId	Yes	String	Unique user identifier (e.g. userId). Must be valid, required for risk control. Format: numbers, letters, or common symbols -~!@#$%&*()_.
sign	Yes	String	Signature.

Request Example (for reference only, actual params per table):

{
  "appId": 1054,
    "orderId": "M100000450012",
    "amount": "500",
    "accountType": "BANK_CARD",
    "bankCode": "BDO",
    "accountNo": "098765432101234567",
    "name": "john doe",
    "phone": "09876543210",
    "email": "johndoe@cashfree.com",
    "subject": "iphone13",
    "body": "ProMotion technology with adaptive refresh rates up to 120Hz",
    "partnerUserId": "149597870",
    "sign": "I1PeK3eJOVsFFNowxVRqMXpeWm1lr/BcRpBi8WsW4wVo1+5CC3JsrFq/m/L2O69NzKHvtDWi4zia3DL3dPut0yMyUyqL91LNCSaeISbGsQPlhEsQpyTOryS/RKOfsrn2Xo37SCF/phAvndOk2jwwGwqM5xLz1ms9Ukl85wv27QFNrXIMxK2p18oe7MpMYrgf+xvEBE/VqCtKMtN9pO449wWwXzHWNPbZ76s4pAvKwRE9yXQDr7Iw14Dktcnl1FoLM4gWM/obkO+mz6SyAGDuXhVh/+OD/IGNiCyTCNq6ciQY28UnCFV6ZIP40gxsFhfBJKbK+Raw7y1Bh912ifYfug=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M100000450013",
        "orderNo": "3023062014149637",
        "sign": "LmhUnkw5j0pMiimsG8rKwdNNZGvXH5MpSmD6mdHZwq1SQwuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
    }
}

Return Data Parameters Description

Parameter	Required	Type
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
sign	String	Signature

Disbursement Query

Brief Description:

Query a disbursement order

URL：/mxn/pay/query

Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must correspond to the currency in the URL)
orderId	Yes	String	Merchant Order Number
orderNo	No	String	Platform Order Number (faster response)
sign	Yes	String	Signature

request

{
    "appId": 1000,
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}

response — Order Failed

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567111",
        "orderNo": "3022111516571436",
        "amount": "100000.00",
        "fee": "0.00",
        "status": 3,
        "errorMsg": "Đơn hàng không tồn tại",
        "sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
    }
}

response — Order Successful

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M1234567112",
        "orderNo": "3022111517401574",
        "amount": "100000.00",
        "fee": "1003.00",
        "status": 2,
        "payTime": "2024-03-01 23:59:59",
        "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oVyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
    }
}

Return Data Parameters Description

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
amount	String	Transaction Amount
fee	String	Transaction Fee
status	Integer	Order Status (0 Not Started, 1 Processing, 2 Success (final), 3 Failed (final), -1 Exception Pending Confirmation)
payTime	String	Payment Success Time (available when status=2) (Mexico Time), format: yyyy-MM-dd HH:mm:ss
errorMsg	String	Payment Failure Reason (available when status=3)
sign	String	Signature

Bank Codes

bankCode List
ABC CAPITAL
ACCENDO BANCO
ACTINVER
AFIRME
AMERICAN EXPRES
ARCUS
ASP INTEGRA OPC
AUTOFIN
AZTECA
AZTECA2
BAJIO
BANAMEX
BANAMEX2
BANCO FINTERRA
BANCO S3
BANCOMEXT
BANCOPPEL
BANCREA
BANJERCITO
BANK OF AMERICA
BANK OF CHINA
BANKAOOL
BANOBRAS
BANORTE
BANORTE2
BANREGIO
BANSEFI
BANSI
BARCLAYS
BBASE
BBVA BANCOMER2
BBVA MEXICO
BMONEX
CAJA POP MEXICA
CAJA TELEFONIST
CB INTERCAM
CI BOLSA
CIBANCO
CLS
CoDi Valida
COMPARTAMOS
CONSUBANCO
CREDICAPITAL
CREDIT SUISSE
CRISTOBAL COLON
DEUTSCHE
DONDE
ESTRUCTURADORES
EVERCORE
FINAMEX
FINCOMUN
FOMPED
FONDO (FIRA)
GBM
HDI SEGUROS
HIPOTECARIA FED
HSBC
HSBC2
ICBC
INBURSA
INDEVAL
INMOBILIARIO
INTERCAM BANCO
INVERCAP
INVEX
JP MORGAN
KUSPIT
LIBERTAD
MASARI
MIFEL
MIZUHO BANK
MONEXCB
MUFG
MULTIVA BANCO
MULTIVA CBOLSA
NAFIN
NU MEXICO
PAGATODO
PROFUTURO
REFORMA
SABADELL
SANTANDER
SANTANDER2
SCOTIABANK
SHINHAN
STP
TACTIV CB
UNAGRA
VALMEX
VALUE
VE POR MAS
VECTOR
VOLKSWAGEN

Collection API

Collection Application

Brief Description:

Create a collection order

URL：/mxn/collect/apply

Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must correspond to the currency in the URL)
orderId	Yes	String	Merchant Order Number (must be unique, no longer than 48 characters)
name	Yes	String	Payer’s Name (format: English letters, spaces allowed, 1–30 characters, "firstName middleName lastName"; middleName optional; special characters allowed: `! -`)
phone	Yes	String	Valid phone number (format reference: Phone Number Format)
email	Yes	String	Valid email address
amount	Yes	String	Transaction Amount (unit: Mex$, precise to two decimal places; do not use punctuation such as “,”)
payType	Yes	String	Payment Method: VA
inBankCode	Yes	String	Collection Code (when payType is VA, inBankCode must be VA)
callBackUrl	Yes	String	Redirect URL after successful payment
callBackFailUrl	Yes	String	Redirect URL after failed payment
notifyUrl	No	String	Callback URL
subject	No	String	Payment Note
body	No	String	Additional Details
partnerUserId	Yes	String	Unique User Identifier (e.g., userId), used for risk control. Must be valid; otherwise, the transaction may be affected. Allowed format: numbers, letters, or common symbols -~!@#$%&*()_.
sign	Yes	String	Signature

request, for example only, specific parameters are subject to the table.

{
    "appId": 1054,
    "orderId": "M233323000059",
    "amount": "300",
    "phone": "09230219312",
    "email": "23423@qq.com",
    "name": "test",
    "inBankCode": "VA",
    "payType": "VA",
    "partnerUserId": "149597870",
    "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M233323000059",
        "orderNo": "6023071013539074",
        "payUrl": "https://a.api-uat.php.com/1L9zQS2",
        "bankCode": "VA",
        "bankNo": "PC0007I10000035",
        "qrCode": "00020101021228760011ph.ppmi.p2m0111OPDVPHM1XXX0315777148000000017041652948137245442930503001520460165303608540810000.php Of Mandalu62310010ph.allbank05062110000803***88310012ph.ppmi.qrph0111OPDVPHM1XXX63042763",
        "sign": "YEoA8Y2JzQFGVzwJSqmemm1Kfv/bfyIfCqv2dp7RNzT5B72AQvdD+nt2nR4sL1HWscvmNHyVt5ovAi7MMhy3ziih/sMph+wPx4YjH3W1h5DyBvSlWvaKfKrK5ViomZ0pPYWydwRHnnRnicxToHK9S6qtSy7Q73O0hdz4hJ9p41Th3ycBl2Q9SeqSZYSY1ohcPDhdyRf2y0prb8rHgpBKzxZ5BKX/1bsE9OmsSEHAEYT8OGgko6aNe8XPAhr4G48cpWTftvnGQuzh0O65nuZRI/PF+Axt2zJCVbFHDDSREI9NlAT82ebDqhlVdxQzKE67D1nxgjb3dPmDUYHOBpmwxQ=="
    }
}

Return Data Parameters Description

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
payUrl	String	Repayment URL; in other cases, it may return instructions or details
bankNo	String	Repayment Account Number (VA)
bankCode	String	Channel Code (VA)
qrCode	String	QR Code content — can be used to generate a QR code
sign	String	Signature

Collection Query

Brief Description:

Query a collection order
When payType = PAYMENT_GATEWAY, the orderNo is returned synchronously and can be queried directly
For other payment methods, after asynchronous notification, use orderNo for second confirmation

URL: /mxn/collect/query

Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (obtained from the backend, must correspond to the currency in the URL)
orderId	Yes	String	Merchant Order Number
orderNo	No	String	Platform Order Number (faster response)
sign	Yes	String	Signature

request

{
    "appId": 1054,
    "orderId": "M22222000028",
    "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}

response

{
    "status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
        "orderId": "M22222000028",
        "orderNo": "6023042811314347",
        "amount": "50000.00",
        "actualAmount": "0.00",
        "fee": "0.00",
        "status": 1,
        "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
    }
}

Return Data Parameters Description

Parameter	Type	Description
orderId	String	Merchant Order Number (must be unique)
orderNo	String	Platform Order Number
amount	String	Transaction Amount
actualAmount	String	Received Amount
fee	String	Transaction Fee
status	Integer	Status (0 = Not Started, 1 = In Progress, 2 = Success (Final), 3 = Failed (Final), -1 = Exception Pending Confirmation)
payTime	String	Payment Success Time (available when status = 2, 4, or 5) (Mexico Time), format: yyyy-MM-dd HH:mm:ss
errorMsg	String	Failure Reason (available when status = 3)
sign	String	Signature