Business APIResponse Models

Business API Response Models

Quote response

The quote envelope returns partner-facing metadata:

  • schemaVersion, quoteId, provider, mode
  • fromCcy, toCcy, direction, amount
  • providerQuoteId, amounts, limits
  • expiresAt, etaSeconds, rateInfo

Normalized order response

Order reads return a stable normalized shape:

  • orderId, publicOrderId, provider
  • providerOrderId, providerQuoteId, routeQuoteId
  • status, canonicalSubReason, providerChoice
  • amounts, currencies, timestamps
  • transactions, choiceCapabilities

Use this as your stable read model instead of depending on provider-native shapes.

Onchain execution response

Onchain resolve, report, and status responses return the normalized execution lifecycle model:

  • schemaVersion, executionPlanId, routeQuoteId, status
  • executionType, executionKind, chainNamespace, executionProvider
  • steps, unsignedPayload, signatureRequests, messageRequests
  • providerRelay, fusionOrchestrated, txHash, failure
  • executionAccessToken on resolve responses for server-to-server report/status calls

Treat executionAccessToken as a scoped credential. Send it only as X-Onchain-Execution-Access-Token for the matching execution plan.

Webhook records

Webhook list and mutation responses expose:

  • webhookId, url, description
  • subscribedEvents, status
  • secretVersion, lastSecretRotatedAt
  • lastDeliveredAt, lastDeliveryStatus
  • deliveryCount, failureCount
  • createdAt, updatedAt

Create and rotate-secret responses return signingSecret. Treat that secret like a credential — it is only returned at secret issuance time.