The ArcenPay API is a REST API over HTTPS. It exposes two kinds of surfaces:
- Developer API — callable with your API key (
api_…, sk_…, rk_… or pk_…) or an embed access token. These are the endpoints your backend and SDKs use.
- Dashboard-managed API — operated from the dashboard UI with a session cookie and team-role permissions. Your application code should not call these directly; the SDKs do not wrap them.
Base URL
All examples in this reference use this base. Local development defaults to http://localhost:3300/api/v1.
Resource map
Get started
Credentials
Customers
Access control
Billing & payments
Public checkout
Dashboard-managed operations
Administrative configurations — such as team member invitations, workspace environments, invoice template visual styling, and webhook signing secrets — are managed directly within the ArcenPay Dashboard. These operations require session-based permissions (OWNER, ADMIN, or FINANCE) and are intentionally separate from the developer REST API surface.
Which key works where
Every endpoint table in this reference marks its accepted credentials. The endpoint auth matrix is the single source of truth for the exact key-per-endpoint compatibility.
Last modified on September 19, 2026
