Brazil API Introduction
About 1 min
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
Brazil's digital payment landscape is a vibrant ecosystem characterized by innovation, inclusivity, and rapid growth, largely fueled by the widespread adoption of Payment Gateway APIs.
- Comprehensive Payment Solutions include PIX...
- Adaptation to Local Market
- Security and Compliance
- Real-Time and Flexible Processing
- Support for Cross-Border Transactions
- Developer and Merchant-Friendly
Development Resources
Code examples

PayInRequestDemo.java— Pay-inPayoutRequestDemo.java— Pay-outInquiryBalanceDemo.java— Balance inquiryInquriyOrderStatusDemo.java— Order / transaction statusSignatureUtils.java— Signing helpers (minify, RSA-SHA256)
pay_in_request_demo.py— Pay-inpay_out_request_demo.py— Pay-outbalance_inquiry.py— Balance inquirystatus-inquiry.py— Order / transaction statusTool_Sign.py— Signing helpers (minify, RSA-SHA256)
pay_in_request_demo.js— Pay-inpay_out_request_demo.js— Pay-outinquiry_balance_demo.js— Balance inquiryinquiry_order_status.js— Order / transaction statusSignatureUtils.js— Signing helpers (minify, RSA-SHA256)
PayInRequestDemo.php— Pay-inPayoutRequestDemo.php— Pay-outInquiryBalanceDemo.php— Balance inquiryInquiryOrderStatusDemo.php— Order / transaction statusSignature.php— Signing helpers (minify, RSA-SHA256)
PayInRequestDemo.cs— Pay-inPayOutRequestDemo.cs— Pay-outBalanceInquiryDemo.cs— Balance inquiryOrderStatusInquiryDemo.cs— Order / transaction statusSignatureUtils.cs— Signing helpers (minify, RSA-SHA256)
PayInRequestDemoV2.go— Pay-inPayoutRequestDemoV2.go— Pay-outBalanceInquiryDemoV2.go— Balance inquiryOrderStatusInquiryDemoV2.go— Order / transaction statusSignatureUtils.go— Signing helpers (minify, RSA-SHA256)
