# Gate Pay DOCS: Global English 1.0.0 ## 1.0.0 - [Global / English / 1.0.0 / API Reference (157 pages)](https://docs.gate.com/_llms/global/en/1-0-0/api-reference.txt): Common, Balance, Institution, Payment, OTC, Convert, Payout, Gift Card, Subscription, Reconciliation, Notifications. ### Guides - [Overview](https://docs.gate.com/global/essentials/version/100/en/common/overview.md): This guide introduces the prerequisites, base configuration, service endpoints, app creation, key management, and supported payment networks and currencies for GatePay external APIs. - [Sandbox Environment](https://docs.gate.com/global/essentials/version/100/en/common/sandbox.md) - [Quickstart](https://docs.gate.com/global/essentials/version/100/en/common/quickstart.md): Run your first GatePay payment flow with the minimum path: signing, order creation, callback handling, and final query. - [Merchant Access](https://docs.gate.com/global/essentials/version/100/en/common/accessguide.md): Explains how merchants create an app, retrieve credentials, configure callbacks, and complete the production-readiness checklist for GatePay. - [Authentication](https://docs.gate.com/global/essentials/version/100/en/common/authentication.md): This guide covers the authentication mechanisms, security protocols, request signing, and callback verification required for integrating with the GatePay API. - [Notification](https://docs.gate.com/global/essentials/version/100/en/common/notification.md): GatePay sends asynchronous notifications to your configured callback URL whenever order status changes. This guide covers the notification structure, callback types, and integration best practices. - [Error](https://docs.gate.com/global/essentials/version/100/en/common/error.md): This guide covers GatePay API error codes and recommended practices for handling errors, callbacks, and asynchronous operations. - [Balance](https://docs.gate.com/global/essentials/version/100/en/common/balance.md): Account reconciliation is critical for maintaining financial accuracy and trust. This guide covers balance queries, fee verification, and funds ledger tracking for end-of-day and periodic reconciliation. - [Payment](https://docs.gate.com/global/essentials/version/100/en/inflow/payment/payment.md): This guide introduces GatePay's core collection products, including hosted checkout payments, address payments, static-address payments, and client-side payment launch flows. - [OTC](https://docs.gate.com/global/essentials/version/100/en/otc.md): Unified GatePay OTC guide covering both on-ramp and off-ramp flows. - [Convert](https://docs.gate.com/global/essentials/version/100/en/internalflow/swap.md): Currency conversion enables merchants to exchange currencies directly using balances in their payment accounts. This capability is essential for multi-currency operations and balance management. - [Payout](https://docs.gate.com/global/essentials/version/100/en/outflow/payout.md): This guide introduces GatePay's payout (withdrawal) capabilities for batch fund distribution, commission payouts, merchant settlements, and other bulk transfer scenarios. - [Gift Card](https://docs.gate.com/global/essentials/version/100/en/inflow/payment/giftcard.md): Gift card functionality allows merchants to create, manage, and track digital gift cards with customizable designs and templates. This guide covers the complete gift card lifecycle. - [Subscription](https://docs.gate.com/global/essentials/version/100/en/inflow/payment/subscription.md): Covers subscription payment product setup, plan management, authorization, deduction modes, and querying recurring or on-demand debit status. - [Reconciliation](https://docs.gate.com/global/essentials/version/100/en/common/reconciliation.md): This document describes Gate Pay's reconciliation capabilities, applicable for end-of-day reconciliation, financial system synchronization, anomaly investigation, and audit tracking. - [x402](https://docs.gate.com/global/essentials/version/100/en/inflow/payment/x402.md): GatePay integrates the x402 open payment protocol so clients can complete on-chain payments automatically through standard HTTP flows. - [Institution](https://docs.gate.com/global/essentials/version/100/en/internalflow/institution.md): Explains dedicated institution APIs, institution merchant APIs, header rules, and the recommended integration path. - [Merchant MCP](https://docs.gate.com/global/essentials/version/100/en/common/merchantMcp.md): Merchant MCP lets clients turn natural-language instructions into GatePay API calls for balance, order, and refund operations. ## OpenAPI Specs - [common-openapi](/global/api-reference/version/100/en/openapi/common-openapi.json) - [preview-merchant-fee-openapi](/global/api-reference/version/100/en/openapi/preview-merchant-fee-openapi.json) - [fund-records-openapi](/global/api-reference/version/100/en/openapi/fund-records-openapi.json) - [institutional-openapi](/global/api-reference/version/100/en/openapi/institutional-openapi.json) - [institution-fee-settings-openapi](/global/api-reference/version/100/en/openapi/institution-fee-settings-openapi.json) - [channel-openapi](/global/api-reference/version/100/en/openapi/institution/channel-openapi.json) - [checkout-payment-openapi](/global/api-reference/version/100/en/openapi/institution/checkout-payment-openapi.json) - [web-payment-openapi](/global/api-reference/version/100/en/openapi/institution/web-payment-openapi.json) - [address-payment-openapi](/global/api-reference/version/100/en/openapi/institution/address-payment-openapi.json) - [fixed-address-openapi](/global/api-reference/version/100/en/openapi/institution/fixed-address-openapi.json) - [common-openapi](/global/api-reference/version/100/en/openapi/institution/common-openapi.json) - [fund-records-openapi](/global/api-reference/version/100/en/openapi/institution/fund-records-openapi.json) - [otc-fiat-openapi](/global/api-reference/version/100/en/openapi/institution/otc-fiat-openapi.json) - [convert-openapi](/global/api-reference/version/100/en/openapi/institution/convert-openapi.json) - [withdraw-openapi](/global/api-reference/version/100/en/openapi/institution/withdraw-openapi.json) - [channel-openapi](/global/api-reference/version/100/en/openapi/channel-openapi.json) - [payment-order-openapi](/global/api-reference/version/100/en/openapi/payment-order-openapi.json) - [checkout-payment-openapi](/global/api-reference/version/100/en/openapi/checkout-payment-openapi.json) - [address-payment-openapi](/global/api-reference/version/100/en/openapi/address-payment-openapi.json) - [web-payment-openapi](/global/api-reference/version/100/en/openapi/web-payment-openapi.json) - [fixed-address-openapi](/global/api-reference/version/100/en/openapi/fixed-address-openapi.json) - [call-payment-openapi](/global/api-reference/version/100/en/openapi/call-payment-openapi.json) - [qrpay-openapi](/global/api-reference/version/100/en/openapi/qrpay-openapi.json) - [otc-fiat-openapi](/global/api-reference/version/100/en/openapi/otc-fiat-openapi.json) - [convert-openapi](/global/api-reference/version/100/en/openapi/convert-openapi.json) - [rate-exchange-openapi](/global/api-reference/version/100/en/openapi/rate-exchange-openapi.json) - [withdraw-openapi](/global/api-reference/version/100/en/openapi/withdraw-openapi.json) - [gift-card-openapi](/global/api-reference/version/100/en/openapi/gift-card-openapi.json) - [productCreate-openapi](/global/api-reference/version/100/en/openapi/subscription/productCreate-openapi.json) - [productPageQuery-openapi](/global/api-reference/version/100/en/openapi/subscription/productPageQuery-openapi.json) - [productQueryOne-openapi](/global/api-reference/version/100/en/openapi/subscription/productQueryOne-openapi.json) - [planSave-openapi](/global/api-reference/version/100/en/openapi/subscription/planSave-openapi.json) - [planList-openapi](/global/api-reference/version/100/en/openapi/subscription/planList-openapi.json) - [planDetail-openapi](/global/api-reference/version/100/en/openapi/subscription/planDetail-openapi.json) - [orderCreate-openapi](/global/api-reference/version/100/en/openapi/subscription/orderCreate-openapi.json) - [orderList-openapi](/global/api-reference/version/100/en/openapi/subscription/orderList-openapi.json) - [orderDetail-openapi](/global/api-reference/version/100/en/openapi/subscription/orderDetail-openapi.json) - [orderComplete-openapi](/global/api-reference/version/100/en/openapi/subscription/orderComplete-openapi.json) - [deductionOrderList-openapi](/global/api-reference/version/100/en/openapi/subscription/deductionOrderList-openapi.json) - [deductionOrderDetail-openapi](/global/api-reference/version/100/en/openapi/subscription/deductionOrderDetail-openapi.json) - [orderDeduct-openapi](/global/api-reference/version/100/en/openapi/subscription/orderDeduct-openapi.json) - [reconciliation-openapi](/global/api-reference/version/100/en/openapi/reconciliation-openapi.json) - [address-payment-callback-openapi](/global/api-reference/version/100/en/openapi/address-payment-callback-openapi.json) - [fixed-address-payment-callback-openapi](/global/api-reference/version/100/en/openapi/fixed-address-payment-callback-openapi.json) - [gate-payment-callback-openapi](/global/api-reference/version/100/en/openapi/gate-payment-callback-openapi.json) - [fiat-payment-callback-openapi](/global/api-reference/version/100/en/openapi/fiat-payment-callback-openapi.json) - [gift-card-payment-callback-openapi](/global/api-reference/version/100/en/openapi/gift-card-payment-callback-openapi.json) - [refund-callback-openapi](/global/api-reference/version/100/en/openapi/refund-callback-openapi.json) - [unresolvedPayNotify-openapi](/global/api-reference/version/100/en/openapi/unresolvedPayNotify-openapi.json) - [fixedAddressRiskNotify-openapi](/global/api-reference/version/100/en/openapi/fixedAddressRiskNotify-openapi.json) - [withdraw-callback-openapi](/global/api-reference/version/100/en/openapi/withdraw-callback-openapi.json) - [batch-transfer-callback-openapi](/global/api-reference/version/100/en/openapi/batch-transfer-callback-openapi.json) - [orderNotify-openapi](/global/api-reference/version/100/en/openapi/subscription/orderNotify-openapi.json) - [paymentNotify-openapi](/global/api-reference/version/100/en/openapi/subscription/paymentNotify-openapi.json)