Canopy API
Documentation
Create a payment intent, hand your user a deposit address, and get paid -- on whichever chain they already hold funds on.
Start here
Accept your first deposit
Create a key, create an intent, and watch a deposit settle end to end. It's the fastest path from zero to a confirmed payment.
Best for a first integration.
Model your payment intents
The complete create-body contract and the one-active-intent-per-wallet rule.
Best for getting the create call right up front.
Route funds where they belong
Name a settlement destination on each intent instead of a fixed merchant wallet. Covers both gates a route needs before Canopy honors it.
Best for apps whose payout target changes per user.
Look up any operation
Method, path, scope and rate limit for every operation, each with a worked request and response.
Best for once you already know what you're calling.
Confirm settlement server-side
Verify signed events and fulfil only once a deposit actually settles, never on a browser signal.
Best for wiring order fulfilment.
Hand the build to an agent
A paste-ready prompt that walks a coding agent through the integration.
Best for delegating the implementation.
Get started
This page indexes the Canopy docs by what you are trying to do. Start with the quickstart below.
- Accept your first deposit. Create a key, create an intent, and watch for settlement, start to finish.
Core concepts
- Payment intents covers the complete create-body contract and the one-active-intent-per-wallet rule.
- Need a per-intent destination? See payout destinations and the two gates that must both be open before one is admitted.
- Credentials lists the three types and where each one is allowed to go.
Guides
- List a customer's live source origins and issue a deposit inbox for one, server to server, with source deposit inboxes.
- Popup timing covers opening the checkout popup synchronously, inside the click handler that triggered it.
- Render the checkout surface inside your own page instead of a popup -- see embed checkout inline.
API reference
- Method, path, scope, rate limit and response statuses for all six operations, each with a worked request and response, live in the API reference.
- Checkout SDK events lists every event the browser SDK emits, and the loader version-pinning pattern.
- React checkout and hooks covers the native component, shared status, typed callbacks and recovery controls.
- Verify signatures and read the settlement event catalog on webhooks.
Errors
Every /api/v1/* error response links directly to its own page via the docs field in the error envelope.