Introduction
Peak Gateway exposes public APIs and SDKs for online checkout, direct transactions, recurring billing, webhooks, and settlement reporting.
Production hosts
| Boundary | Base URL | Use |
|---|---|---|
| Management | https://api.peakgateway.co | Merchant configuration, direct transaction proxies, subscriptions, reports, settlements, webhooks, and OAuth client administration |
| Authentication | https://api.peakgateway.co/auth | OAuth 2.0 tokens, API-key exchange, and authentication metadata |
| Checkout | https://pay.peakgateway.co | Hosted checkout sessions, shopper payment, wallets, and checkout-facing subscription flows |
Staging uses https://staging-api.peakgateway.co and
https://staging-pay.peakgateway.co. Keep staging and production credentials,
tokens, and resource IDs separate.
Public API families
- OAuth 2.0 client credentials and API-key token exchange
- Hosted checkout sessions and shopper payment
- Sale, authorization, capture, refund, and void operations
- Stored payment methods and recurring subscriptions
- Apple Pay and Google Pay configuration and payment
- Webhook endpoint management and delivery inspection
- Settlement, transaction, recurring-revenue, and monthly reports
- SAML and OAuth client administration
The generated API reference is a curated integration contract, not an inventory of every internal service route. Use the TypeScript or Kotlin SDK reference for the complete supported SDK surface. Private Cloud Run endpoints and portal-only Firebase routes are intentionally excluded.
Request conventions
- Monetary amounts are integer minor units unless an operation states otherwise.
- Currency values are uppercase ISO 4217 codes such as
USD. - Send OAuth access tokens as
Authorization: Bearer <ACCESS_TOKEN>. - Supply
Idempotency-Keyon supported money-moving write operations. - Treat credentials, access tokens, API keys, session tokens, and processor data as secrets.
Start with Getting Started, then use the generated API reference for the operation you are integrating.