Business API Endpoints

Complete reference of all Business API routes. Every route is authenticated with an HMAC-signed request and consumes request + weight budget from your key's rate limit.

Discovery & catalog

GET/api/v3

Readiness documentLists the mounted business routes. Permission: none. Weight: 1.

GET/api/v3/currencies

Supported currency catalogReturns schemaVersion, currencies, count, degraded, reason, source. Permission: prices:read. Weight: 1.

GET/api/v3/tokens/popular

Popular token shortlistCurated high-liquidity tokens for pickers. Permission: prices:read. Weight: 1.

GET/api/v3/tokens/search

Search tokens by symbol or nameQuery param q. Permission: prices:read. Weight: 1.

GET/api/v3/tokens/by-address

Resolve a token by chain + contract addressParams chain, address. Permission: prices:read. Weight: 1.

GET/api/v3/tokens/logo

Token logo asset lookupReturns the canonical logo URL for a token. Permission: prices:read. Weight: 1.

Routing & quotes

GET/api/v3/routes

Discover private/offchain and Onchain DEX & Bridge routesUse provider=wormhole; keep walletAddress as the source signer and pass recipientAddress for cross-namespace recipients (e.g. Mayan EVM→Solana). Permission: prices:read. Weight: 2.

POST/api/v3/routes/resolve

Resolve an offchain route quoteReturns a short-lived createToken for order creation. Permission: orders:create. Weight: 3.

POST/api/v3/quotes

Create a partner quote (legacy)Not used for Wormhole bridge route cards. Permission: prices:read. Weight: 1.

POST/api/v3/onchain/routes/resolve

Resolve an onchain routeUse the routeQuoteId from /routes; returns an execution plan and executionAccessToken. Approval-first venues are two-phase: a response carrying phase="approval" with requiresReResolveAfterApproval=true contains only the ERC-20 approval. Confirm it on-chain, then resubmit the identical body with a NEW Idempotency-Key to receive phase="swap" on the same executionPlanId — reusing the approval-phase key replays the approval and cannot advance the plan. Report only the swap hash. Permission: orders:create. Weight: 4.

POST/api/v3/onchain/executions

Report onchain executionRequires X-Onchain-Execution-Access-Token and an Idempotency-Key. Permission: orders:create. Weight: 4.

GET/api/v3/onchain/executions/{executionPlanId}

Poll onchain execution statusRequires X-Onchain-Execution-Access-Token. Permission: orders:read. Weight: 1.

Orders

POST/api/v3/orders

Create a business order200 for idempotent reuse, 201 for a newly accepted order. Requires Idempotency-Key. Permission: orders:create. Weight: 10.

GET/api/v3/orders/{orderId}

Full normalized order viewOrder must belong to the API principal. Permission: orders:read. Weight: 1.

GET/api/v3/orders/{orderId}/status

Order status aliasSame payload family as the main order read. Permission: orders:read. Weight: 1.

POST/api/v3/orders/{orderId}/emergency

Emergency actionChoose EXCHANGE or REFUND, idempotent. Permission: orders:update. Weight: 2.

POST/api/v3/orders/{orderId}/refund

Request a refund for an orderIdempotent mutation; provide the refund address. Permission: orders:update. Weight: 3.

POST/api/v3/orders/{orderId}/notifications/email

Attach email notificationIdempotent mutation. Permission: notifications:write. Weight: 1.

GET/api/v3/orders/{orderId}/qr

Fetch QR imagesDeposit-instruction QR codes. Permission: orders:read. Weight: 1.

Webhooks & callbacks

POST/api/v3/callbacks/test

Test callback deliveryUseful for verifying your webhook endpoint. Permission: webhooks:write. Weight: 1.

GET/api/v3/webhooks

List webhook subscriptionsRead existing subscriptions. Permission: webhooks:read. Weight: 1.

POST/api/v3/webhooks

Create webhook subscriptionReturns the signing secret once. Permission: webhooks:write. Weight: 1.

PATCH/api/v3/webhooks/{webhookId}

Update a webhookPatch URL, description, events, status. Permission: webhooks:write. Weight: 1.

POST/api/v3/webhooks/{webhookId}/rotate-secret

Rotate webhook secretReturns the new secret once. Permission: webhooks:write. Weight: 1.

POST/api/v3/webhooks/{webhookId}/replay

Replay past deliveriesBy event ID or time window. Permission: webhooks:write. Weight: 1.

Authentication

Request Models