Merchant API
Create invoices and read your catalog from a server-side integration.
Start with hosted checkout
The smallest complete integration creates an invoice on your server, redirects the customer to the returned url, and processes a signed webhook when the payment changes. Start with the quickstart.
API reference
| Operation | Authentication |
|---|---|
| Create an invoice | Merchant ID and signature |
| Create an invoice from an item | Merchant ID and signature |
| List catalog items | Merchant ID and signature |
| Get a catalog item | Merchant ID and signature |
| Get a public invoice | No merchant credentials |
Download OpenAPI 3.1 for these operations. The schema describes the existing routes under /api; there is no /v1 prefix to add.
Base URL and environments
Use the public API origin supplied for your deployment. Examples use https://api.example.com as a placeholder. The hostname, available assets, and configured limits are deployment-specific.
A demo checkout is not proof of a testnet sandbox. Confirm your testing environment and credentials before attempting a blockchain payment; see testing.
Scope
This reference is for external merchant integrations. Console sessions and /api/console routes are internal to the merchant UI. Balances, withdrawals, refunds, team management, and webhook configuration are not exposed as merchant REST operations here.
Read authentication, errors and retries, and webhooks before going live.