Skip to content

Overview

Server-to-server merchant API. Operations authenticate with a tenant API key (sent via the x-tenant-api-key header) unless marked “No API key required”. Errors are returned with a stable JSON envelope: { "code": "exceptions.<area>.<reason>", "message": "...", "extension": { ... } }. Branch on code rather than parsing message.

Each operation that needs an API key requires one scope on it (see x-required-scope and the operation description). A key missing that scope receives 403 exceptions.auth.insufficientScope. Operations marked “No API key required” accept unauthenticated calls.

  • invoices.list
  • invoices.create
  • invoices.cancel
  • withdrawals.list
  • withdrawals.create
  • deposits.list
  • deposits.create
  • addressProvision.list
  • addressProvision.create
  • currencies.list
  • x402.verify
  • x402.settle
  • x402.list

Information

  • OpenAPI version: 3.0.0

Secret key from the merchant dashboard. Authenticates one account. The account is taken from the key; requests do not send an account id.

Security scheme type: apiKey

Header parameter name: x-tenant-api-key