Skip to main content

API Reference

About 2 min

API Reference

Before you integrate

Use Sandbox for testing, then switch gateway URLs and credentials for Production. See the integration guide and signature guide. Response code meanings are in error codes.

Environment

EnvironmentProtocolMedia TypeBase URL
SandboxHTTPSapplication/jsonhttps://sandbox-gateway.smilepayz.com
ProductionHTTPSapplication/jsonhttps://gateway.smilepayz.com

All regional APIs share the same gateway hosts. Pick your market below for endpoints, request fields, and payment methods.


Asia

North America

South America

Africa

Digital currency


Common API categories

Each region documents the same core building blocks where applicable:

CategoryTypical endpoints
TransactionPay-in (v2.0/transaction/pay-in), pay-out (v2.0/disbursement/pay-out)
InquiryOrder status (v2.0/inquiry-status), balance inquiry
Payment methodsSupported rails and channel codes for that market

Need help choosing a region?

Match the merchant's settlement currency and payment method to the corresponding market docs. For cross-cutting rules (signing, callbacks, order numbers), use Product and Guide.