v2026-11-10.1
OpenAPI 3.1.0
Payroo Embedded Partner API
The routes your server calls with your partner credential (x-api-key): sessions, employers, operations, webhooks, usage, and the public meta and JWKS routes.
The components call their own routes with the session token; your code never calls those, so they are not listed here.
Conventions: JSON, UTF-8, ISO 8601 UTC timestamps, identifiers as strings. Every response carries X-Correlation-Id; every create accepts Idempotency-Key.
Start here
- Check the sandbox is up:
GET /metaanswers your environment and contract version. - Create a sandbox company:
POST /employers, then poll the operation untilsucceeded. - Mint a component session:
POST /sessionsfrom your session route, for each signed-in user. - Receive webhooks:
PUT /webhooks/config, then watch the deliveries. - Read your usage:
GET /usage?month=YYYY-MM, and the audit per company.
Client Libraries