API Overview
How the Tidepay API is structured and what you need before calling it.
The Tidepay API is a REST interface over HTTPS. Request and response bodies use JSON. Use standard HTTP methods (GET, POST, PUT, PATCH, DELETE).
Base URL:
https://api.tidepay.cc/v1Unlike APIs with separate sandbox/production domains, Tidepay uses this single URL for both environments — the API key you authenticate with determines which one a request runs against. See Authentication.
Initial setup
- Create your merchant account in the Tidepay dashboard.
- Generate an API key — Settings → API keys. See Authentication.
POST /offerswith your pricing, and, if you need automatic payout splits, aspliton the pricing option.- Open the
checkoutUrlit returns — that is a complete end-to-end flow.
Guides
Authentication
API keys (X-API-Key), live vs. test keys, and how the same base URL serves
both environments.
Core concepts
How Offers, Subscriptions, Customers, Payments, and Settlement Wallets fit together.
Errors
The flat error shape, HTTP status code summary, and how 401/404/409
are used.
Test mode
Testing your integration end-to-end with no wallet, no blockchain, and no real funds.
Chains
Supported chains and tokens, live network status, and the testnet dry-run flow.
Webhooks
Signed delivery of subscription and payment events to your own endpoint.
Pagination
How list endpoints page through results.
Consumption limits
Per-endpoint rate limits and idempotent creates.
Endpoint groups
The API reference groups operations by product area:
| Area | Use for |
|---|---|
| Offers | What you sell and on what terms — pricing and checkout URL included |
| Subscriptions | A customer's recurring relationship with an offer |
| Customers | Payer records — the wallet that funds a subscription |
| Payments | Every transaction that happened: one-off charges and recurring cycles alike |
| Currencies | Supported chains and tokens |
| Wallets | Your registered settlement wallet per token |
| Webhooks | Your delivery endpoint, and your signing secret |
| Sandbox | Test-only endpoints for exercising the charge flow without real funds |
Interactive request samples and schemas are on each endpoint page in the API Reference.
Related
- Authentication
- Errors
- Test mode
- Chains
- Webhooks
- API Reference — every endpoint, generated from the live OpenAPI spec.