Business API Endpoints
Complete reference of all Business API routes.
| Route | Purpose | Notes |
|---|---|---|
GET /api/v3 | Readiness document | Lists the mounted business routes |
GET /api/v3/currencies | Supported currency catalog | Returns schemaVersion, currencies, count, degraded, reason, source |
POST /api/v3/quotes | Create a partner quote | Legacy quote path; not used for Wormhole bridge route cards |
GET /api/v3/routes | Discover private/offchain and Onchain DEX & Bridge routes | Use provider=wormhole; keep walletAddress as the source signer and pass recipientAddress for cross-namespace recipients such as Mayan EVM-to-Solana discovery |
POST /api/v3/routes/resolve | Resolve an offchain route quote | Returns a short-lived createToken for order creation |
POST /api/v3/onchain/routes/resolve | Resolve an onchain route | Use the routeQuoteId from /routes; returns an execution plan and executionAccessToken |
POST /api/v3/onchain/executions | Report onchain execution | Requires X-Onchain-Execution-Access-Token and an idempotency key |
GET /api/v3/onchain/executions/{executionPlanId} | Poll onchain execution status | Requires X-Onchain-Execution-Access-Token |
POST /api/v3/orders | Create a business order | 200 for idempotent reuse, 201 for newly accepted order |
GET /api/v3/orders/{orderId} | Full normalized order view | Order must belong to the API principal |
GET /api/v3/orders/{orderId}/status | Order status alias | Same payload family as the main order read |
POST /api/v3/orders/{orderId}/emergency | Emergency action | Choose EXCHANGE or REFUND, idempotent |
POST /api/v3/orders/{orderId}/notifications/email | Attach email notification | Idempotent mutation |
GET /api/v3/orders/{orderId}/qr | Fetch QR images | Deposit instruction QR codes |
POST /api/v3/callbacks/test | Test callback delivery | Useful for webhook testing |
GET /api/v3/webhooks | List webhook subscriptions | Read existing subscriptions |
POST /api/v3/webhooks | Create webhook subscription | Returns signing secret once |
PATCH /api/v3/webhooks/{webhookId} | Update a webhook | Patch URL, description, events, status |
POST /api/v3/webhooks/{webhookId}/rotate-secret | Rotate webhook secret | Returns new secret once |
POST /api/v3/webhooks/{webhookId}/replay | Replay past deliveries | By event ID or time window |