Pay-in collection

Collect payments in Mexico (MXN): SPEI, CODI, OXXO; see Payment methods. paymentMethod is required on the request.

Request

POST/v2.0/transaction/pay-in

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/transaction/pay-in
production: https://gateway.smilepayz.com/v2.0/transaction/pay-in

Header Parameters

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. Mexico CST −06:00).
X-SIGNATURE	M	String	Request signature; Signature Generation.
X-PARTNER-ID	M	String	merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	6–32 alphanumeric; unique per merchant.
purpose	M	String(64)	UTF-8; length 1–64.
merchant	M	Object	Merchant routing and settlement.
merchantId	M	String	Platform merchant ID.
merchantName	O	String	UTF-8 display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name (UTF-8).
money	M	Object	Amount and currency.
currency	M	String	MXN only.
amount	M	Number	Integer centavos (e.g. 20000 = MXN 200.00).
paymentMethod	M	String	SPEI, CODI, or OXXO; Payment methods.
expiryPeriod	O	Number	Session TTL (seconds); default 3600; max 86400 (channel may enforce shorter TTL).
redirectUrl	O	String(256)	Post-pay redirect URL; HTTP(S); max 256.
callbackUrl	O	String(256)	Status webhook URL; HTTP(S); max 256.

---

Example Body – Transaction Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-06:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 20000,
        "currency": "MXN"
    },
    "orderNo": "200012c4c2ad5334dfwj3",
    "paymentMethod": "SPEI",
    "purpose": "Payment for online purchase"
}

Responses

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

Field	Required	Type	Description
code	M	String	00 = success; other codes = error.
message	M	String	Result text (UTF-8).
orderNo	M	String	Echo of orderNo.
merchant	M	Object	Merchant Model.
merchantId	M	String	Merchant ID.
merchantName	O	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
money	M	Object	Money Model.
currency	M	String	MXN.
amount	M	Number	Integer centavos.
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss±HH:mm
channel	M	Object	Channel Model.
paymentMethod	M	String	Settled method (SPEI, CODI, OXXO, …).
paymentUrl	O	String	Cashier URL when returned.
qrString	O	String	QR payload / barcode when returned.
receiverBankName	O	String	Bank / brand code when returned.
vaNumber	O	String	Virtual account / reference when returned.
additionalInfo	O	Object	Extra channel data when returned.
tradeNo	O	String	Platform trade ID.
status	O	String	Status Model.
responseCode	O	String	Channel result code when returned (e.g. CODI / OXXO).
responseMessage	O	String	Channel result text when returned.

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-06:00

{
    "code": "00",
    "message": "Successful",
    "orderNo": "20001394eeb7b44c2460b892f767",
    "merchant": {
        "merchantId": "20001",
        "merchantName": "bradytest123www",
        "accountNo": "11420011202402290943"
    },
    "money": {
        "currency": "MXN",
        "amount": 20000
    },
    "transactionTime": "2024-12-13T04:11:54-06:00",
    "channel": {
        "additionalInfo": {},
        "paymentMethod": "SPEI",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=141200112412131711531135",
        "receiverBankName": "OPM",
        "vaNumber": "684180167000008210"
    },
    "tradeNo": "141200012412131711531135",
    "status": "PROCESSING"
}

{
  "code": "00",
  "message": "Successful",
  "orderNo": "20011331546f1ca1447c69cc0caf",
  "merchant": {
    "merchantId": "20011",
    "merchantName": "bradytest123www",
    "accountNo": "11420011202402290943"
  },
  "money": {
    "currency": "MXN",
    "amount": 20
  },
  "transactionTime": "2025-10-27T00:58:38-06:00",
  "channel": {
    "paymentMethod": "CODI",
    "qrString": "{\"TYP\":20,\"v\":{\"DEV\":\"00001618035151761092/60\"},\"ic\":{\"IDC\":\"335b075298\",\"SER\":1733687829,\"ENC\":\"mgXOeZ0ufbeSkj0rFNi3Giu2Qy8zcoAV7yA54fHDhY9kyYz2s82PQLXH+1ObjyoFnQT8QT/aEuTNYquQbTYDO+TWLUEZHrLXQcLsPJ5qaH9LqfXuLRDZAN6wpwIxAvZudKxXKk3VDpswsKPcT98K/VHrEn1zz3MHMIz0cmJsoV+kUX1ed1gr7J162JimfjtOxC/MNKbMsvqZf8f48uDImxTWxEwGtWj0on1C8bs0ZnkBibn8buY4yxRK73ixQMywmXsWxwxp8hoAd8Yh7jO02QYof0F4uehUuu1E8Q6iomEcIYtorFRBcnzrUxLEsjSzMxeDAV4nhF7faVB65UTUp/LyV7lwzPQu5EKF/XUzEeOVyAz0tTQHnbGfkkEh44L5\"},\"CRY\":\"FK0Vm7dtBI+R5tv/3oIM9kkOJLfdSQVG0y6fVQHyAcw=\"}",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1412001125102713583676303"
  },
  "tradeNo": "1412001125102713583676303",
  "status": "PROCESSING",
  "responseCode": "2009000",
  "responseMessage": "Successful"
}

{
  "code": "00",
  "message": "Successful",
  "orderNo": "20011f15fd99a451042d585ba32c",
  "merchant": {
    "merchantId": "20011",
    "merchantName": "bradytest123www",
    "accountNo": "11420011202402290943"
  },
  "money": {
    "currency": "MXN",
    "amount": 20
  },
  "transactionTime": "2025-10-27T00:52:25-06:00",
  "channel": {
    "paymentMethod": "OXXO",
    "qrString": "8201880001347082",
    "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=1412001125102713522460381"
  },
  "tradeNo": "1412001125102713522460381",
  "status": "PROCESSING",
  "responseCode": "2009000",
  "responseMessage": "Successful"
}

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Callback signature; verify.

Body Parameters

Field	Required	Type	Description
orderNo	M	String	Same orderNo as pay-in.
tradeNo	M	String	Platform tradeNo.
merchantId	M	String	Merchant ID.
merchantName	M	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
paymentMethod	M	String	Settled channel (SPEI, CODI, OXXO, …).
transactionTime	M	String	Completion time (yyyy-MM-ddTHH:mm:ss±HH:mm).
status	M	String	Status Model.
money	M	Object	Final amount; Money Model.
currency	M	String	MXN.
amount	M	Number	Integer centavos. Note: notification amount may differ from the original request; use it for reconciliation.
payer	O	Object	Payer snapshot when returned; Payer Model.
name	O	String	Payer display name when returned.

Return

Important

Respond with the string SUCCESS only.

{
  "orderNo": "20001qXTL6qYuXTkxPDPdTXJc",
  "tradeNo": "141200012412110650535520",
  "merchantId": "20001",
  "merchantName": "test",
  "subMerchantId": "",
  "subMerchantName": "",
  "paymentMethod": "SPEI",
  "transactionTime": "2024-12-10T17:50:54-06:00",
  "status": "SUCCESS",
  "money": {
    "currency": "MXN",
    "amount": 20000
  },
  "payer": {
    "name": "Carlos Rodriguez"
  }
}

SUCCESS