Skip to main content

Bearer token

All EQX API requests require a Bearer token in the Authorization header.
Authorization: Bearer <your_token>
Tokens are scoped to your integrator workspace. Generate and rotate them from the EQX dashboard → Settings → API Keys. Tokens do not expire by default; rotating a token immediately invalidates the previous one.
Never commit tokens to source control. Use environment variables or a secrets manager.

Idempotency keys

Write operations that create or mutate financial state require an Idempotency-Key header:
Idempotency-Key: <your_unique_key>
The key must be unique per logical operation — typically a UUID v4 or a client-generated reference. EQX stores the outcome of the first request for 24 hours; subsequent requests with the same key return the cached response without re-executing the operation. When idempotency keys are required:
EndpointRequired
POST /api/transactions/commitYes
Generate your idempotency key before making the request and store it alongside your transaction record. If you receive a network timeout, you can safely replay the request using the same key.

Token scopes

Tokens issued to integrators cover all integrator-audience endpoints. There is no sub-scoping within the integrator tier at this time — any valid integrator token can call any integrator endpoint within your workspace.

API base URL

EnvironmentBase URL
Sandboxhttps://sandbox.api.eqxpay.io
Productionhttps://api.eqxpay.io
Use sandbox for integration testing. Sandbox payouts are simulated — no real funds move.