← Home
—/hyax-api/v1/orders

External payments overview

If you take payments on your own site or in another tool, report them to Hyax so revenue lands in the same dashboard as native checkout and gets attributed back to the content that drove it. Attribution is keyed on the visitor ID: pass `visitorId` (or `hyax_vid` in Stripe metadata) and the order is joined to that visitor's touchpoints. Without it the order is still recorded, just unattributed. Every method deduplicates on the external order ID, so retries and webhook replays are safe.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request 

# This route is session-based, multipart, or provider-specific.
# Inspect: apps/web/server/routes/hyax-api/

Response 

Pick one

  Stripe metadata      Zero extra calls. Add hyax_vid to the PaymentIntent
                       metadata; the connected-account webhook records the
                       order for you. Requires Stripe connected in Team
                       settings.

  Browser (hyax.js)    hyax('order', { … }) on your thank-you page. No API
                       key, but the request Origin must be an allowed
                       tracking domain.

  Server-side API      POST /hyax-api/v1/orders with a team API key. Best for
                       webhooks and server-rendered checkouts; works with any
                       payment provider.

Recorded fields

  paymentPlatform      From "source" — STRIPE, PAYPAL, NOWPAYMENTS,
                       USDC_BASE, MANUAL, or OTHER
  paymentStatus        Always PAID (report only settled payments)
  externalOrderId      Your "orderId" — the deduplication key