# Gate Pay DOCS

## Docs

- [Notifications](https://docs.gate.com/api-reference/version/100/en/common/asyncNotification.md): Explains GatePay asynchronous notifications, including payload structure, status enums, retry rules, and signature verification.
- [Best Practices](https://docs.gate.com/api-reference/version/100/en/common/bestPractices.md): Provides recommended implementation patterns for callbacks, order queries, refunds, and security controls.
- [Error Codes](https://docs.gate.com/api-reference/version/100/en/common/errorCodes.md): Summarizes common GatePay error codes, their meanings, and recommended handling actions.
- [Institution Headers](https://docs.gate.com/api-reference/version/100/en/common/institutionalCommonHeaders.md): Explains the required headers for institution APIs and how to use X-GatePay-On-Behalf-Of.
- [Merchant Access](https://docs.gate.com/api-reference/version/100/en/common/merchantAccess.md): Explains the base URL, credential preparation, and common request headers used by GatePay merchants.
- [Security and Signature](https://docs.gate.com/api-reference/version/100/en/common/securityAndSignature.md): Explains protocol rules, shared response structure, request headers, and the GatePay signing algorithm.
- [Supported Currencies](https://docs.gate.com/api-reference/version/100/en/common/supportedCurrencies.md): Lists the main networks and currencies currently supported by GatePay payment flows.
- [Query Supported Chains](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/chainQuery.md): Query all available chains that support payment with the provided currency
- [Create Address Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/createOrder.md): Create an order. When the order currency and payment currency are consistent, create a direct address payment order; if the order currency and payment currency are inconsistent, create a convert address payment order.
- [Query Supported Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/currencies.md): Query the list of all currencies supported for Gate address payment
- [Address Payment Convert Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/paymentRefund.md): Initiate a refund for the convert address payment order, which is only applicable to the convert address payment order.
- [Query Address Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/queryOrder.md): Check the details of the new address payment order, the specified parameters must correspond to the address payment order, otherwise an error message will be returned.
- [Address Payment Direct Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/refund.md): Initiate a refund for the direct address payment order, which is only applicable to the direct address payment order.
- [Query Supported Convert Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/supportedconvertcurrencies.md): Users can query the supported payment currency for the converted payment order, and then selects one to create an convert payment order
- [Query On-chain Transaction Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/addresspayment/transactiondetail.md): Query the transaction details of the address direct payment order on the chain, including the direct payment record within the validity period and the payment record beyond the validity period.
- [Order Status Callback](https://docs.gate.com/api-reference/version/100/en/endpoint/callpayment/callback.md): When the status of the prepaid order changes, such as expiration of the order due to exhaustion of payment time or successful payment of the order, the GatePay background will send a notification to the merchant to the notification address, which is the callback url provided by the merchant at regis…
- [Query Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/callpayment/query.md): In order to synchronize order information with merchants, GatePay provides a query interface enabling the merchants to query prepaid orders and refund orders.
- [Validate Payment Launch Parameters](https://docs.gate.com/api-reference/version/100/en/endpoint/callpayment/sdk.md): Payment Component Validation Interface
- [Create Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/channel/createChannel.md): Users create clients and record information through this interface. The name of a client is required and must be unique under the same merchant; other attributes are not required. If you need to save a wallet address, you need to confirm the network; if not, the network can be left blank. Spare fiel…
- [Delete Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/channel/deleteChannel.md): Delete information about a client.
- [Query Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/channel/queryChannel.md): Query information about the current merchant's client list.
- [Update Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/channel/updateChannel.md): Users edit clients and record information through this interface. The name of a client is required and must be unique under the same merchant; other attributes are not required. If you need to save a wallet address, you need to confirm the network; if not, the network can be left blank. Spare fields…
- [Create Checkout Order](https://docs.gate.com/api-reference/version/100/en/endpoint/checkout/order.md): Place an order at the cashier. Returns prepay ID, payment URL, QR content, and chain/address information for the consumer to complete payment.
- [Query Checkout Order](https://docs.gate.com/api-reference/version/100/en/endpoint/checkout/orderQuery.md): Query checkout order details by prepay ID or merchant trade number. Either prepayId or merchantTradeNo is required.
- [Query Refund Supported Networks](https://docs.gate.com/api-reference/version/100/en/endpoint/checkout/refundChains.md): Query supported networks for refund currencies. Returns chain information for the given order currency.
- [Query Refund Details](https://docs.gate.com/api-reference/version/100/en/endpoint/checkout/refundDetails.md): Query cashier refund details by merchant refund ID. Returns full refund status and transaction information.
- [Create Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/checkout/refundV2.md): Cashier's refund interface V2. Supports original or specified refund style, Gate or Web3 refund channel, and more options.
- [Preview Merchant Fee](https://docs.gate.com/api-reference/version/100/en/endpoint/clearing/previewMerchantFee.md): This API is used to estimate the transaction fee amount based on merchant information, order amount, and other parameters. Only Gate Pay merchants can call this API.
- [Query Balance](https://docs.gate.com/api-reference/version/100/en/endpoint/common/balanceQuery.md): Retrieve the payment account balance for the merchant.
- [Query Transaction Fee](https://docs.gate.com/api-reference/version/100/en/endpoint/common/feeQuery.md): Query the detailed fee breakdown for a specific order by merchant order ID. Error codes: 550139 - Order bill not found; 550140 - No payment record found; 550141 - Fees are being calculated, please try again later.
- [Create Convert Order](https://docs.gate.com/api-reference/version/100/en/endpoint/convert/convert.md): Initiate convert.
- [Query Supported Convert Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/convert/currency.md): Query available convert currencies.
- [Query Convert Order](https://docs.gate.com/api-reference/version/100/en/endpoint/convert/order.md): Query order.
- [Query Supported Convert Pairs](https://docs.gate.com/api-reference/version/100/en/endpoint/convert/pair.md): Query available currency pairs.
- [Preview Convert Quote](https://docs.gate.com/api-reference/version/100/en/endpoint/convert/preview.md): Preview quote.
- [Query Supported Chains and Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/fixedaddress/chains.md): Queries the networks and currencies supported by GatePay for static address collection.
- [Delete Static Address](https://docs.gate.com/api-reference/version/100/en/endpoint/fixedaddress/delete.md): Deletes an already generated and valid static collection address.
- [Static Address Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/fixedaddress/detail.md): Views the details of an already generated and valid static collection address.
- [Create EVM Static Address](https://docs.gate.com/api-reference/version/100/en/endpoint/fixedaddress/evm-save.md): For the same customer, create a static collection address that can correspond to multiple networks, applicable only to EVM networks.
- [List Static Addresses](https://docs.gate.com/api-reference/version/100/en/endpoint/fixedaddress/list.md): Queries the list of generated and valid static collection addresses.
- [Static Address Order List](https://docs.gate.com/api-reference/version/100/en/endpoint/fixedaddress/order-query.md): Queries the static collection order list.
- [Create Static Address](https://docs.gate.com/api-reference/version/100/en/endpoint/fixedaddress/save.md): Generates a static collection address based on the specified currency and network.
- [Funds Ledger](https://docs.gate.com/api-reference/version/100/en/endpoint/fundrecords/orderlist.md): Merchants can query the transaction history of their balance accounts through this API. It supports pagination to handle large volumes of data, filtering by time range, and precise searches by financial type, order ID, currency, and other fields. This helps merchants efficiently reconcile funds and…
- [Unresolved Payment Notification](https://docs.gate.com/api-reference/version/100/en/endpoint/fundrecords/unresolvedPayNotify.md): Sent once per unresolved payment event to the merchant. The callback body includes `bizType`, `bizId`, `bizStatus`, and `data`.
- [Query Supported Chains](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/addresspayment/chainQuery.md): Query all available chains that support payment with the provided currency
- [Create Address Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/addresspayment/createOrder.md): Create an order. When the order currency and payment currency are consistent, create a direct address payment order; if the order currency and payment currency are inconsistent, create a convert address payment order.
- [Query Supported Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/addresspayment/currencies.md): Query the list of all currencies supported for Gate address payment
- [Address Payment Convert Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/addresspayment/paymentRefund.md): Initiate a refund for the convert address payment order, which is only applicable to the convert address payment order.
- [Query Address Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/addresspayment/queryOrder.md): Check the details of the new address payment order, the specified parameters must correspond to the address payment order, otherwise an error message will be returned.
- [Query Supported Convert Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/addresspayment/supportedconvertcurrencies.md): Users can query the supported payment currency for the converted payment order, and then selects one to create an convert payment order
- [Query On-chain Transaction Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/addresspayment/transactiondetail.md): Query the transaction details of the address direct payment order on the chain, including the direct payment record within the validity period and the payment record beyond the validity period.
- [Order Status Callback](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/callpayment/callback.md): When the status of the prepaid order changes, such as expiration of the order due to exhaustion of payment time or successful payment of the order, the GatePay background will send a notification to the merchant to the notification address, which is the callback url provided by the merchant at regis…
- [Query Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/callpayment/query.md): In order to synchronize order information with merchants, GatePay provides a query interface enabling the merchants to query prepaid orders and refund orders.
- [Validate Payment Launch Parameters](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/callpayment/sdk.md): Payment Component Validation Interface
- [Create Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/channel/createChannel.md): Users create clients and record information through this interface. The name of a client is required and must be unique under the same merchant; other attributes are not required. If you need to save a wallet address, you need to confirm the network; if not, the network can be left blank. Spare fiel…
- [Delete Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/channel/deleteChannel.md): Delete information about a client.
- [Query Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/channel/queryChannel.md): Query information about the current merchant's client list.
- [Update Customer](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/channel/updateChannel.md): Users edit clients and record information through this interface. The name of a client is required and must be unique under the same merchant; other attributes are not required. If you need to save a wallet address, you need to confirm the network; if not, the network can be left blank. Spare fields…
- [Create Checkout Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/checkout/order.md): Place an order at the cashier. Returns prepay ID, payment URL, QR content, and chain/address information for the consumer to complete payment.
- [Query Checkout Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/checkout/orderQuery.md): Query checkout order details by prepay ID or merchant trade number. Either prepayId or merchantTradeNo is required.
- [Query Refund Supported Networks](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/checkout/refundChains.md): Query supported networks for refund currencies. Returns chain information for the given order currency.
- [Query Refund Details](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/checkout/refundDetails.md): Query cashier refund details by merchant refund ID. Returns full refund status and transaction information.
- [Create Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/checkout/refundV2.md): Cashier's refund interface V2. Supports original or specified refund style, Gate or Web3 refund channel, and more options.
- [Preview Merchant Fee](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/clearing/previewMerchantFee.md): This API is used to estimate the transaction fee amount based on merchant information, order amount, and other parameters. Only Gate Pay merchants can call this API.
- [Query Account Balance](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/common/balanceQuery.md): Retrieve the payment account balance for the merchant.
- [Query Transaction Fee](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/common/feeQuery.md): Query the detailed fee breakdown for a specific order by merchant order ID. Error codes: 550139 - Order bill not found; 550140 - No payment record found; 550141 - Fees are being calculated, please try again later.
- [Create Convert Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/convert/convert.md): Initiate convert.
- [Query Supported Convert Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/convert/currency.md): Query available convert currencies.
- [Query Convert Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/convert/order.md): Query order.
- [Query Supported Convert Pairs](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/convert/pair.md): Query available currency pairs.
- [Preview Convert Quote](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/convert/preview.md): Preview quote.
- [Query Supported Chains and Currencies](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fixedaddress/chains.md): Queries the networks and currencies supported by GatePay for static address collection.
- [Delete Static Address](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fixedaddress/delete.md): Deletes an already generated and valid static collection address.
- [Static Address Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fixedaddress/detail.md): Views the details of an already generated and valid static collection address.
- [Create EVM Static Address](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fixedaddress/evm-save.md): For the same customer, create a static collection address that can correspond to multiple networks, applicable only to EVM networks.
- [List Static Addresses](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fixedaddress/list.md): Queries the list of generated and valid static collection addresses.
- [Static Address Order List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fixedaddress/order-query.md): Queries the static collection order list.
- [Create Static Address](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fixedaddress/save.md): Generates a static collection address based on the specified currency and network.
- [Funds Ledger](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fundrecords/orderlist.md): Merchants can query the transaction history of their balance accounts through this API. It supports pagination to handle large volumes of data, filtering by time range, and precise searches by financial type, order ID, currency, and other fields. This helps merchants efficiently reconcile funds and…
- [Unresolved Payment Notification](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/fundrecords/unresolvedPayNotify.md): Sent once per unresolved payment event to the merchant. The callback body includes `bizType`, `bizId`, `bizStatus`, and `data`.
- [Query Available Currency Balance](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/gift/balance.md): Query the balance of all available currencies under the current merchant account.
- [Create Gift Card](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/gift/create.md): Create a new gift card with specified title, template, currency and amount.
- [Query Gift Card](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/gift/query.md): Query gift card details by card number or redemption code. When both parameters are provided, key takes priority.
- [Gift Card Template List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/gift/tempList.md): Get the list of available gift card cover templates.
- [Bank Countries](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/bank-countries.md): Query available countries for bank account registration.
- [Create Bank Account](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/bank-create.md): Create a linked bank account for OTC settlement.
- [Delete Bank Account](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/bank-delete.md): Delete a linked bank account.
- [Bank Account List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/bank-list.md): List linked bank accounts.
- [Submit Bank Account Material Supplement](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/bank-material-supplement.md): Submit additional KYC or compliance documents for an existing linked OTC bank account when GatePay requests a material supplement.
- [OTC Callback Webhook](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/callback.md): OTC order result callback sent to the merchant callback URL for both on-ramp and off-ramp flows.
- [Cancel Deposit Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/deposit-cancel.md): Cancel an OTC deposit order before payment is confirmed.
- [Confirm Deposit Payment](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/deposit-confirm.md): Notify the system that the merchant has completed the offline fiat transfer. This endpoint uses multipart/form-data. When generating the signature, use the plain text payload "timestamp\nnonce\n\n" and do not append the multipart body.
- [Create Deposit Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/deposit-create.md): Create an OTC fiat deposit order.
- [Deposit Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/deposit-detail.md): Query detail for a fiat deposit order.
- [Deposit List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/deposit-list.md): List OTC deposit orders.
- [OTC Quote](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/quote.md): Get a fiat-to-crypto quote for the OTC on-ramp flow.
- [Create Withdrawal Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/withdraw-create.md): Create an OTC withdrawal order after obtaining a quote.
- [Withdrawal Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/withdraw-detail.md): Query the detail of an OTC withdrawal order.
- [Withdrawal List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/otc/withdraw-list.md): Query OTC withdrawal orders in batch.
- [Create QR Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/qrpay/native.md): Create a Web payment prepay order and return the prepay ID, QR content and Web payment component redirect URL.
- [Exchange Rate Query](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/rateexchange/query.md): This API provides real-time exchange rates between fiat currencies and cryptocurrencies. It supports multiple trading pairs and is available exclusively to Gate Pay merchants.
- [Query Deduction Order Details](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/deductionOrderDetail.md): Query deduction order details
- [Query Subscription Deduction List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/deductionOrderList.md): Query deduction order list
- [Subscription Order Status Transition](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/orderComplete.md): Subscription order status transition
- [Create Subscription Order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/orderCreate.md): Create subscription order
- [Initiate Subscription Deduction](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/orderDeduct.md): Merchant-initiated deduction against a subscription order. Provide either `subscriptionOrderNo` or `merchantSubscriptionOrderNo`. `merchantDeductNo` must be unique per merchant for idempotency.
- [Query Subscription Order Details](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/orderDetail.md): Query subscription order details
- [Query Subscription Order List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/orderList.md): Query subscription order list
- [Subscription Order Status Update Notification](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/orderNotify.md): Subscription order status update notification
- [Payment Deduction Notification](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/paymentNotify.md): Callback when a subscription deduction attempt completes (payment / deduction notification).
- [Query Subscription Plan Details](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/planDetail.md): Query subscription plan details
- [Create Product](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/productCreate.md): Create product
- [Query Product List](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/productPageQuery.md): Query product list details
- [Query Product Details](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/subscription/productQueryOne.md): Query product details
- [Create Native Pre-order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/webpayment/native.md): Create a Web payment prepay order and return the prepay ID, QR content and Web payment component redirect URL.
- [Close Pre-order](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/webpayment/orderClose.md): When the merchant order is canceled, the merchant can proactively request GatePay to close an unpaid prepay order.
- [Query Order Status](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/webpayment/orderQuery.md): Query the status and detailed information of an order.
- [Web Payment Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/webpayment/refund.md): Initiate a refund for an order that has been successfully paid. Refunds cannot be canceled, withdrawn, or rolled back.
- [Query Web Payment Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/webpayment/refundQuery.md): Query the status and details of a refund order by merchant-generated refund request ID.
- [Withdrawal Callback](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/withdraw/callback.md): When a batch withdrawal order status changes (e.g., all successful, all failed, or partially successful), GatePay will send an asynchronous POST notification to the callback URL configured by the merchant.
- [Query Supported Withdrawal Chains](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/withdraw/currencyChains.md): Query supported blockchain networks and related configuration for a specific currency.
- [Query Withdrawal Records](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/withdraw/walletWithdrawals.md): Query account withdrawal records list based on filter criteria.
- [Create Withdrawal](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/withdraw/withdraw.md): Create a batch withdrawal order. The merchant submits one batch ID with multiple withdrawal sub-orders.
- [Query Withdrawal Status](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/withdraw/withdrawQuery.md): Query the status and details of a batch withdrawal order and its sub-orders by batch ID and detail status.
- [Query Withdrawal Fee](https://docs.gate.com/api-reference/version/100/en/endpoint/institution/withdraw/withdrawStatus.md): Query withdrawal fee configuration and limits for a specific currency.
- [Sub-account Callback](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/callbackNotification.md): When sub-account creation succeeds or fails, GatePay sends a POST request to the callback URL configured by the merchant and pushes the notification body. The merchant must accept and parse it at that URL and return HTTP 200 to acknowledge receipt.
- [Create Charge](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/charge.md): Initiate an account-to-account charge. `X-GatePay-On-Behalf-Of` specifies the initiating account ID for this transaction, and `accountId` specifies the payer account ID (the debited account). In the current version, this is a synchronous API and returns the final execution result directly.
- [Charge Record Query](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/chargeDetail.md): Query historical charge records by merchant batch number for result backfill or reconciliation checks. In the current version, it is no longer used as an asynchronous polling endpoint.
- [Create Sub-account](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/create.md): Create a new sub-account for a customer under the institution account and register the account holder information.
- [Create Fee Rule](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/fee-settings/create.md): Creates the first markup rule for a specified sub-account. After creation, the sub-account is charged with the base rate plus the configured markup.
- [List Fee Rules](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/fee-settings/list.md): Returns a paginated overview of fee rules filtered by sub-account, markup presence, and status. Each record contains the core fields of the current version for operations and back-office display.
- [Get Fee Rule Configuration Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/fee-settings/query.md): Returns the effective configuration for a sub-account at a specified time. If omitted, the current effective configuration is returned.
- [Update Fee Rule](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/fee-settings/upgrade.md): Creates a new rule version. A successful request does not immediately replace the current effective rule, but any pending-effective version is invalidated. When the new version becomes effective, it fully replaces the current rule.
- [List Sub-accounts](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/list.md): Paginated list of sub-accounts.
- [Query Sub-account Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/query.md): Query sub-account details.
- [Create Transfer](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/transfer.md): Initiate an account-to-account transfer. `X-GatePay-On-Behalf-Of` specifies the initiating account ID for this transaction, and `accountId` specifies the recipient account ID. In the current version, this is a synchronous API and returns the final execution result directly.
- [Transfer Record Query](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/transferDetail.md): Query historical transfer records by merchant batch number for result backfill or reconciliation checks. In the current version, it is no longer used as an asynchronous polling endpoint.
- [Update Sub-account](https://docs.gate.com/api-reference/version/100/en/endpoint/institutional/update.md): Update sub-account details and account holder information.
- [Bank Countries](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/bank-countries.md): Query available countries for bank account registration.
- [Create Bank Account](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/bank-create.md): Create a linked bank account for OTC settlement.
- [Delete Bank Account](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/bank-delete.md): Delete a linked bank account.
- [Bank Account List](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/bank-list.md): List linked bank accounts.
- [Submit Bank Account Material Supplement](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/bank-material-supplement.md): Submit additional KYC or compliance documents for an existing linked OTC bank account when GatePay requests a material supplement.
- [OTC Callback Webhook](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/callback.md): OTC order result callback sent to the merchant callback URL for both on-ramp and off-ramp flows.
- [Cancel Deposit Order](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/deposit-cancel.md): Cancel an OTC deposit order before payment is confirmed.
- [Confirm Deposit Payment](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/deposit-confirm.md): Notify the system that the merchant has completed the offline fiat transfer. This endpoint uses multipart/form-data. When generating the signature, use the plain text payload "timestamp\nnonce\n\n" and do not append the multipart body.
- [Create Deposit Order](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/deposit-create.md): Create an OTC fiat deposit order.
- [Deposit Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/deposit-detail.md): Query detail for a fiat deposit order.
- [Deposit List](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/deposit-list.md): List OTC deposit orders.
- [OTC Quote](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/quote.md): Get a fiat-to-crypto quote for the OTC off-ramp flow.
- [Create Withdrawal Order](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/withdraw-create.md): Create an OTC withdrawal order after obtaining a quote.
- [Withdrawal Detail](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/withdraw-detail.md): Query the detail of an OTC withdrawal order.
- [Withdrawal List](https://docs.gate.com/api-reference/version/100/en/endpoint/otc/withdraw-list.md): Query OTC withdrawal orders in batch.
- [Create Order](https://docs.gate.com/api-reference/version/100/en/endpoint/payment/order.md): Create a new payment order on GatePay. The response returns payment information that can be used to redirect the user to the payment page or render a payment QR code.
- [Create QR Payment Order](https://docs.gate.com/api-reference/version/100/en/endpoint/qrpay/native.md): Create a Web payment prepay order and return the prepay ID, QR content and Web payment component redirect URL.
- [Exchange Rate Query](https://docs.gate.com/api-reference/version/100/en/endpoint/rateexchange/query.md): This API provides real-time exchange rates between fiat currencies and cryptocurrencies. It supports multiple trading pairs and is available exclusively to Gate Pay merchants.
- [Query Deduction Order Details](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/deductionOrderDetail.md): Query deduction order details
- [Query Subscription Deduction List](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/deductionOrderList.md): Query deduction order list
- [Subscription Order Status Transition](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/orderComplete.md): Subscription order status transition
- [Create Subscription Order](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/orderCreate.md): Create subscription order
- [Initiate Subscription Deduction](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/orderDeduct.md): Merchant-initiated deduction against a subscription order. Provide either `subscriptionOrderNo` or `merchantSubscriptionOrderNo`. `merchantDeductNo` must be unique per merchant for idempotency.
- [Query Subscription Order Details](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/orderDetail.md): Query subscription order details
- [Query Subscription Order List](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/orderList.md): Query subscription order list
- [Subscription Order Status Update Notification](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/orderNotify.md): Subscription order status update notification
- [Payment Deduction Notification](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/paymentNotify.md): Callback when a subscription deduction attempt completes (payment / deduction notification).
- [Query Subscription Plan Details](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/planDetail.md): Query subscription plan details
- [Query Subscription Plan List](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/planList.md): Query subscription plan list
- [Create Subscription Plan](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/planSave.md): Create subscription plan
- [Create Product](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/productCreate.md): Create product
- [Query Product List](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/productPageQuery.md): Query product list details
- [Query Product Details](https://docs.gate.com/api-reference/version/100/en/endpoint/subscription/productQueryOne.md): Query product details
- [Create Native Pre-order](https://docs.gate.com/api-reference/version/100/en/endpoint/webpayment/native.md): Create a Web payment prepay order and return the prepay ID, QR content and Web payment component redirect URL.
- [Close Pre-order](https://docs.gate.com/api-reference/version/100/en/endpoint/webpayment/orderClose.md): When the merchant order is canceled, the merchant can proactively request GatePay to close an unpaid prepay order.
- [Query Order Status](https://docs.gate.com/api-reference/version/100/en/endpoint/webpayment/orderQuery.md): Query the status and detailed information of an order.
- [Web Payment Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/webpayment/refund.md): Initiate a refund for an order that has been successfully paid. Refunds cannot be canceled, withdrawn, or rolled back.
- [Query Web Payment Refund](https://docs.gate.com/api-reference/version/100/en/endpoint/webpayment/refundQuery.md): Query the status and details of a refund order by merchant-generated refund request ID.
- [Withdrawal Callback](https://docs.gate.com/api-reference/version/100/en/endpoint/withdraw/callback.md): When a batch withdrawal order status changes (e.g., all successful, all failed, or partially successful), GatePay will send an asynchronous POST notification to the callback URL configured by the merchant.
- [Query Supported Withdrawal Chains](https://docs.gate.com/api-reference/version/100/en/endpoint/withdraw/currencyChains.md): Query supported blockchain networks and related configuration for a specific currency.
- [Query Withdrawal Records](https://docs.gate.com/api-reference/version/100/en/endpoint/withdraw/walletWithdrawals.md): Query account withdrawal records list based on filter criteria.
- [Create Withdrawal](https://docs.gate.com/api-reference/version/100/en/endpoint/withdraw/withdraw.md): Create a batch withdrawal order. The merchant submits one batch ID with multiple withdrawal sub-orders.
- [Query Withdrawal Status](https://docs.gate.com/api-reference/version/100/en/endpoint/withdraw/withdrawQuery.md): Query the status and details of a batch withdrawal order and its sub-orders by batch ID and detail status.
- [Query Withdrawal Fee](https://docs.gate.com/api-reference/version/100/en/endpoint/withdraw/withdrawStatus.md): Query withdrawal fee configuration and limits for a specific currency.
- [Merchant Access](https://docs.gate.com/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/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.
- [Balance](https://docs.gate.com/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.
- [Error](https://docs.gate.com/essentials/version/100/en/common/error.md): This guide covers GatePay API error codes and recommended practices for handling errors, callbacks, and asynchronous operations.
- [Merchant MCP](https://docs.gate.com/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.
- [Notification](https://docs.gate.com/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.
- [Overview](https://docs.gate.com/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.
- [Quickstart](https://docs.gate.com/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.
- [Gift Card](https://docs.gate.com/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.
- [Payment](https://docs.gate.com/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.
- [Subscription](https://docs.gate.com/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.
- [x402](https://docs.gate.com/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/essentials/version/100/en/internalflow/institution.md): Explains dedicated institution APIs, institution merchant APIs, header rules, and the recommended integration path.
- [Convert](https://docs.gate.com/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.
- [OTC](https://docs.gate.com/essentials/version/100/en/otc.md): Unified GatePay OTC guide covering both on-ramp and off-ramp flows.
- [Payout](https://docs.gate.com/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.

## OpenAPI Specs

- [withdraw-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/withdraw-openapi.json)
- [common-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/common-openapi.json)
- [checkout-payment-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/checkout-payment-openapi.json)
- [institutional-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/institutional-openapi.json)
- [otc-fiat-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/otc-fiat-openapi.json)
- [address-payment-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/address-payment-openapi.json)
- [payment-order-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/payment-order-openapi.json)
- [payment-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/payment-openapi.json)
- [withdraw-callback-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/withdraw-callback-openapi.json)
- [web-payment-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/web-payment-openapi.json)
- [unresolvedPayNotify-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/unresolvedPayNotify-openapi.json)
- [productQueryOne-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/productQueryOne-openapi.json)
- [productPageQuery-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/productPageQuery-openapi.json)
- [productCreate-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/productCreate-openapi.json)
- [planDetail-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/planDetail-openapi.json)
- [paymentNotify-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/paymentNotify-openapi.json)
- [orderNotify-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/orderNotify-openapi.json)
- [orderList-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/orderList-openapi.json)
- [orderDetail-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/orderDetail-openapi.json)
- [orderCreate-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/orderCreate-openapi.json)
- [orderComplete-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/orderComplete-openapi.json)
- [deductionOrderList-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/deductionOrderList-openapi.json)
- [deductionOrderDetail-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/deductionOrderDetail-openapi.json)
- [rate-exchange-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/rate-exchange-openapi.json)
- [qrpay-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/qrpay-openapi.json)
- [preview-merchant-fee-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/preview-merchant-fee-openapi.json)
- [gift-card-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/gift-card-openapi.json)
- [fund-records-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/fund-records-openapi.json)
- [fixed-address-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/fixed-address-openapi.json)
- [convert-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/convert-openapi.json)
- [channel-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/channel-openapi.json)
- [call-payment-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/call-payment-openapi.json)
- [call-payment-callback-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/call-payment-callback-openapi.json)
- [address-openapi](https://docs.gate.com/api-reference/version/100/cn/openapi/address-openapi.json)
- [planSave-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/planSave-openapi.json)
- [planList-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/planList-openapi.json)
- [orderDeduct-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/subscription/orderDeduct-openapi.json)
- [institution-fee-settings-openapi](https://docs.gate.com/api-reference/version/100/en/openapi/institution-fee-settings-openapi.json)