Skip to main content

Quick Entry

These entry cards cover the full merchant documentation path from onboarding and payments to OTC, convert, payout, and institution capabilities. Start with Overview, Quickstart, and Merchant Access, then continue into the product line you need.

Overview

Review the documentation structure, integration prerequisites, base URL, credentials, and reading order.

Quickstart

Run the first signing, order creation, callback, and order confirmation flow as quickly as possible.

Merchant Access

Check app creation, credential retrieval, callback setup, and pre-go-live requirements.

Authentication

Review signing, request headers, callback verification, and core security rules.

Notification

Review callback handling rules, event types, terminal-state judgment, and processing order.

Balance

See account balance, fees, fund records, and reconciliation guidance.

Reconciliation

Review collection/payout order list pulling, end-of-day reconciliation, and discrepancy investigation.

Payment

Cover order payment, hosted checkout, address payment, web payment, and related callbacks.

OTC

Review fiat on-ramp and off-ramp quotes, order creation, confirmation, queries, and callbacks.

Convert

Review balance-based conversion, quote preview, order placement, and rate lookup.

Payout

Review crypto withdrawals and fiat payouts, including initiation, queries, statuses, and callbacks.

Gift Card

Review gift card creation, templates, queries, and balance usage scenarios.

Subscription

Review products, plans, subscription orders, deductions, and related notifications.

x402

Review the GatePay integration path for AI Agent and HTTP 402 payment scenarios.

Institution

Review sub-accounts, charge, transfer, and the institution-side merchant APIs.

Merchant MCP

Review Merchant MCP capabilities, target scenarios, and integration notes.

API Reference

Browse the full endpoint catalog, field definitions, and response structures by product module.