API reference
Every endpoint of the CryptoPay API, generated from the OpenAPI document with request and response schemas, code samples and a playground.
The API lives under /v1. Authenticate with Authorization: Bearer <api key>: cpr_test_… keys see test mode (public testnets, no real funds), cpr_live_… keys see live mode. Every create call accepts an Idempotency-Key header; errors use one envelope (error.type, error.code, error.message, request_id).
The same document powers the live reference at /docs on the API host and the TypeScript SDK.
Resources
- API keys: API keys (dashboard sessions only)
- Auth: Sign-in (email code, EVM and Solana wallets)
- Balances: Ledger balances per asset and chain
- Checkout: Public endpoints used by the hosted checkout
- Merchant: Merchant account, settlement and branding
- Payment links: Reusable hosted checkout pages
- Payments: Create, retrieve, list and cancel payments
- Payouts: Send funds from the balance to an external wallet
- Providers: Push receivers for chain data providers (Alchemy, Helius); polling remains the source of truth
- Request logs: Developer console: recent API requests
- Wallet: Custodial balance of the signed-in user (dashboard sessions)
- Webhooks: Webhook endpoints and delivery log