Skip to main content

Authentication

Authorization: Bearer sk_live_...
  • Store-scoped: one store per key
  • Hashed at rest (SHA-256); prefix sk_live_ with first 12 chars shown in dashboard
  • Cannot access Merchant Admin session APIs
Create keys in Get API credentials.

Default developer scopes

ScopeAccess
invoices:readList and read invoices
invoices:writeCreate and cancel invoices
transactions:readRead on-chain payment transactions
payment_links:read / payment_links:writePayment links
webhooks:read / webhooks:writeWebhook endpoints and deliveries
Use transactions:read (not legacy payments:read).

WooCommerce keys

KeyScopesUse
Bootstrapwoocommerce:bootstrapConnect only (24h)
Dedicatedinvoices:create, invoices:read, Woo scopesPlugin runtime (auto-issued)
Dedicated keys cannot access payment links, transaction list, or developer webhook management.

Scope errors

HTTP 403:
{
  "error": {
    "type": "permission_error",
    "code": "INSUFFICIENT_SCOPE",
    "message": "Missing transactions:read scope"
  }
}