Mexico API Introduction

Getting started

Use Sandbox for integration tests, then switch to Production when you go live. For merchant credentials and environment switching, see the integration guide. For request signing, see signature generation.

API reference

Area	Documentation
Transaction	Pay-in collection · Disbursement (pay-out)
Inquiry	Transaction status · Balance inquiry
Settlement	Settlement · Settlement SLA
Payment methods	Payment methods

Environment Configuration

Environment	Protocol	Media Type	Base URL
Sandbox	HTTPS	application/json	https://sandbox-gateway.smilepayz.com
Production	HTTPS	application/json	https://gateway.smilepayz.com

API Overview

The API accepts application/json request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. You can use the API in sandbox mode, which does not affect your live data or interact with the banking networks.
The API key you use to authenticate the request determines whether the request is sandbox mode or production mode.

Development Resources

Code examples

smilepayz-demo-java →

• PayInRequestDemo.java — Pay-in
• PayoutRequestDemo.java — Pay-out
• InquiryBalanceDemo.java — Balance inquiry
• InquriyOrderStatusDemo.java — Order / transaction status
• SignatureUtils.java — Signing helpers (minify, RSA-SHA256)

smilepayz-demo-python →

• pay_in_request_demo.py — Pay-in
• pay_out_request_demo.py — Pay-out
• balance_inquiry.py — Balance inquiry
• status-inquiry.py — Order / transaction status
• Tool_Sign.py — Signing helpers (minify, RSA-SHA256)

smilepayz-demo-node.js →

• pay_in_request_demo.js — Pay-in
• pay_out_request_demo.js — Pay-out
• inquiry_balance_demo.js — Balance inquiry
• inquiry_order_status.js — Order / transaction status
• SignatureUtils.js — Signing helpers (minify, RSA-SHA256)

smilepayz-sdk-php →

• PayInRequestDemo.php — Pay-in
• PayoutRequestDemo.php — Pay-out
• InquiryBalanceDemo.php — Balance inquiry
• InquiryOrderStatusDemo.php — Order / transaction status
• Signature.php — Signing helpers (minify, RSA-SHA256)

smilepayz-demo-cs →

• PayInRequestDemo.cs — Pay-in
• PayOutRequestDemo.cs — Pay-out
• BalanceInquiryDemo.cs — Balance inquiry
• OrderStatusInquiryDemo.cs — Order / transaction status
• SignatureUtils.cs — Signing helpers (minify, RSA-SHA256)

smilepayz-demo-golang →

• PayInRequestDemoV2.go — Pay-in
• PayoutRequestDemoV2.go — Pay-out
• BalanceInquiryDemoV2.go — Balance inquiry
• OrderStatusInquiryDemoV2.go — Order / transaction status
• SignatureUtils.go — Signing helpers (minify, RSA-SHA256)