Skip to main content

API Reference — Overview

Base URL: https://api.thiqwave.com/api. All paths below are /v1/... under $BASE_URL.

There is one base URL for both environments — your API key decides whether a call runs against TEST or LIVE. See Environments.

Auth matrix​

SurfaceAuthHeader
customers, beneficiaries, transactions/*, payments, webhooks, logs, customers/:id/accounts, transactions/quote*API keyX-API-Key: $THIQWAVE_API_KEY
pricing/*, partner-wallets, applications/*, auth/me | register | keys | lookup-emailBearer token (Dashboard)Authorization: Bearer $PARTNER_TOKEN
GET wallets/validatePublic — no credential required—
/admin/*, admin routes, provider-callback receivers, internal servicesNever published—

Headers​

HeaderRequiredNotes
X-API-Keyserver-to-serveryour application secret
AuthorizationdashboardBearer <jwt>
Idempotency-Keymoney-moving POSTrequired on POST /v1/transactions, POST /v1/payments
X-Request-IDoptionalechoed as correlation_id
Content-Typebodiesapplication/json

Conventions​

  • IDs: UUIDv7 / NanoID external IDs; internal DB IDs never exposed.
  • Money: always string; ledger/quote amounts are integer minor units (*_minor).
  • Timestamps: ISO 8601 UTC.
  • Pagination: limit (1–100, default 25) + cursor; response { "data": [...], "next_cursor": "…" | null }.
  • Errors: { "error": { code, message, correlation_id, details } } — see Errors.

Resources​

Customers · Beneficiaries · Quotes · Transactions · Payments · Webhooks · Wallets · Pricing · Accounts · Logs