Canopy API
Documentation
Create a payment intent and give your user a deposit address. They fund it from whichever chain they already hold funds on.
Start here
Accept your first deposit
Get a key, create an intent, and watch a deposit settle. The fastest way to a confirmed payment.
Best for a first integration.
Model your payment intents
Every field you can send when creating an intent, and the one-active-intent-per-wallet rule.
Best for getting the create call right up front.
Route funds where they belong
Send each deposit to the wallet the intent names, not one fixed merchant wallet. Covers the two settings that must be on first.
Best for apps whose payout target changes per user.
Look up any operation
Method, path, scope and rate limit for every operation, with an example request and response.
Best when you know which call you need.
Confirm settlement server-side
Verify signed events. Fulfil orders only after a deposit settles, never on a browser event.
Best for wiring order fulfilment.
Hand the build to an agent
A prompt you can paste into a coding agent to build the integration. Or use Canopy's MCP server so an agent can call Canopy directly.
Best for delegating the implementation.
Get started
New to Canopy? Start with the quickstart.
- Accept your first deposit. Get a key, create an intent, and wait for settlement.
Core concepts
- Payment intents lists every field you can send when creating an intent. It also covers the rule that each wallet can have only one active intent.
- To set a different destination on each intent, see payout destinations. Two settings must both be on before Canopy accepts one.
- Credentials lists the three credential types and where each one can be used.
Guides
- Source deposit inboxes shows how to list the chains a customer can pay from and get a deposit address for one. Both calls run from your server.
- Popup timing explains why you must open the checkout popup synchronously, inside the click handler.
- To show checkout inside your own page instead of a popup, see embed checkout inline.
API reference
- The API reference covers all six operations. Each has its method, path, scope, rate limit, response statuses and an example request and response.
- Checkout SDK events lists every event the browser SDK emits. It also shows how to pin the loader to a version.
- React checkout and hooks covers the native React component, shared status, typed callbacks and recovery controls.
- Webhooks shows how to verify signatures and lists the settlement events.
Errors
Every /api/v1/* error response has a docs field. It links to the page for that error.