Platform APIs
Overview
This chapter introduces the prerequisites, base configuration, service endpoints, app creation, key management, and supported payment networks and currencies for GatePay external APIs
Authentication
This chapter describes the communication standards, required request headers, unified response schema, signing rules, and callback signature verification for GatePay external APIs
Balance
This chapter introduces GatePay account query and reconciliation capabilities, including balance query, order fee query, funds ledger query, and the recommended end-of-day reconciliation flow
Payment
This chapter introduces GatePay’s core collection products, including hosted checkout payments, address payments, static-address payments, and client-side payment launch flows
Payout
This chapter introduces GatePay payout capabilities, including batch creation of withdrawals/payouts, querying batch and sub-order status, and asynchronous result confirmation
Swap
This chapter introduces the GatePay swap capability. Merchants can convert currencies directly using balances in the payment account. Typical scenarios include post-collection conversion, unified settlement currency, and balance rebalancing
Institution
This chapter describes the external integration model for GatePay Institution API, including sub-account management, agency acquiring, funds query, payouts, transfer/charge, refunds, and swap capabilities
Gift Card
This chapter introduces GatePay gift card APIs, including gift card creation, cover template query, balance query, and gift card detail query
Notification
This chapter describes the asynchronous notification mechanism, callback retry strategy, callback message structure, status enumerations, and field definitions for various GatePay callbacks
Errors
This chapter lists common GatePay API error codes and recommended handling methods, and provides best practices for payments, refunds, callbacks, and secure integration