PayPulse uses two authentication methods depending on the endpoint.
API Key authentication
Pass your API key in the X-Api-Key header:
API keys are project-scoped. Each key belongs to one project and grants access to that project’s data (plans, customers, subscriptions, invoices, etc.).
Test keys never process real payments. Always use test keys during development.
JWT authentication
Some endpoints (merchant management, API key creation) require a JWT token:
Get a token via the login endpoint.
Dual-auth endpoints
Some endpoints accept both API key and JWT. These routes tie a project to a merchant for additional security:
For these, pass both headers:
Error responses