Skip to main content
If this is your first integration, the recommended reading order is:
  1. Quickstart
  2. Merchant Access
  3. Authentication
  4. Notification
  5. The guide and API Reference for your target product flow

​
Merchant Onboarding and App Configuration

​
Base URL

ComponentValue
Service Base URLhttps://openplatform.gateapi.io
All API paths in this documentation must be combined with the base URL to form the full request URL.

​
Create and Configure an App

Follow these steps to set up your application in the GatePay Merchant Portal:
StepAction
1Log in to the GatePay Merchant Portal and complete merchant registration and initial setup.
2Fill in the required business information and submit your merchant application.
3Navigate to the app configuration page and create or configure a new application.
4Retrieve your ClientId from the application list.
5Configure the callback URL as needed to receive asynchronous notifications.

​
Configuration Credentials

After completing app configuration, you will receive the following credentials:
CredentialDescription
ClientIdUnique identifier for your application. Used in all API requests via the X-GatePay-Certificate-ClientId header (see Authentication and Security for details).
Payment API SecretServer-side signing key for payment-related API requests and signature verification.
Authorization SecretServer-side signing key for authorization API requests and signature verification (used only by authorization APIs).
Callback URLEndpoint configured to receive asynchronous payment notifications.
Important: Any API that uses asynchronous notifications requires a valid callback URL to be configured; otherwise, notifications cannot be delivered. For details on how to verify incoming callbacks, see Authentication and Security.

​
Common Request Headers

For most non-institution APIs, requests commonly use the following headers:
HeaderDescription
X-GatePay-Certificate-ClientIdApplication identity
X-GatePay-TimestampUTC timestamp in milliseconds
X-GatePay-NonceRandom nonce
X-GatePay-SignatureRequest signature generated from the signing rules
X-GatePay-On-Behalf-OfInstitution-only delegated header. It is required on every institution API except POST /merchant/open/institution/v1/accounts/create, GET /merchant/open/institution/v1/accounts/query, and GET /merchant/open/institution/v1/accounts/list.
For full header, signing, and verification details, refer to the Authentication and Security guide.

​
SDK Support

The latest official SDK and client repositories are maintained under the Gate GitHub organization: https://github.com/gate The currently public multi-language SDK / client resources include:
RepositoryLanguageDescription
gatepay-sdk-javaJavaGatePay Java repository, repository
gatepay-sdk-goGoGatePay Go repository, repository
gatepay-sdk-pythonPythonGatePay Python SDK repository, repository
gatepay-sdk-androidAndroidGatePay Android SDK repository, repository
gatepay-sdk-iosiOSGatePay iOS SDK repository, repository
gatepay-call-payment-sdk-androidAndroid Call PaymentGatePay Android Call Payment SDK repository, repository
gatepay-call-payment-sdk-iOSiOS Call PaymentGatePay iOS Call Payment SDK repository, repository
Use the Gate GitHub organization page as the source of truth for the latest repository list. If a specific flow does not yet have a ready-made SDK wrapper, you can still integrate directly through the REST APIs documented here.

​
Supported Payment Networks and Currencies

​
Blockchain Networks and Supported Cryptocurrencies

The following networks and tokens are supported for address-based payments:
Blockchain NetworkSupported Currencies
Ethereum / ERC20ETH, POL, USDC, USDT, USDS
PolygonPOL, USDC, USDT
Arbitrum One / ERC20USDC, USDT
BNB Smart Chain / BEP20BNB, USDT
SolanaSOL, USDC, USDT
Tron / TRC20TRX, USDT
BaseUSDC
TonUSDT
Bitcoin BRC20 / OrdinalsBTC

​
Supported Currencies for Other Payment Channels

The following cryptocurrencies and digital assets are supported across other payment methods: BTC, USDT, USD, GT, ETH, EOS, DOGE, DOT, SHIB, LTC, ADA, BCH, FIL, ZEC, BNB, UNI, XRP, STEPG, SUPE, LION, FROG

​
Next Steps

  • If you want to run the first end-to-end flow quickly, start with Quickstart
  • For authentication details and request signing, see Authentication and Security
  • For payment API integration, refer to your specific payment flow documentation
  • For error handling and best practices, consult the error codes and troubleshooting guide