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

  1. Check the sandbox is up: GET /meta answers your environment and contract version.
  2. Create a sandbox company: POST /employers, then poll the operation until succeeded.
  3. Mint a component session: POST /sessions from your session route, for each signed-in user.
  4. Receive webhooks: PUT /webhooks/config, then watch the deliveries.
  5. Read your usage: GET /usage?month=YYYY-MM, and the audit per company.
Server:https://sandbox.payroo.com.au/api/v1/embedded

Sandbox

Client Libraries