Payroo Embedded

Payroo Embedded lets your product run Australian payroll for your customers without building payroll. Your server mints a short-lived session for a signed-in user of yours; your page mounts Payroo components (company setup, employees, run payroll, pay run history, calendar, employee self-service) that talk to Payroo on that session. Payroo files to the ATO, pays super, produces payslips and keeps the records. Sensitive values (bank account numbers, tax file numbers) are captured in Payroo-origin secure fields and never enter your page.

How it fits together

Piece Where it runs What it does
Partner credential your server only Authenticates your backend to Payroo (x-api-key). Issued once by Payroo; never in a browser
Session route your server Calls POST /v1/embedded/sessions and returns the result to your page
Runtime packages your page @payroo-group/embedded-react (native React components) or @payroo-group/embedded-loader (plain HTML)
Frame shell Payroo origin <PayrooFrame component="…" /> renders a component in a Payroo-origin iframe when you prefer not to host the UI
Webhooks your server Signed events (employer.provisioned, payrun.accepted, …) so your system reacts without polling

Two shells, one runtime: every component works natively in your React page (your DOM, your theme tokens) and inside the Payroo frame shell. Both emit the same page events and run on the same session.

What your server calls. Only the Partner API, with your partner credential: mint, refresh and revoke sessions (/sessions), create employers and read their status and audit (/employers), follow operations (/operations), configure webhooks and replay deliveries (/webhooks), and read usage (/usage). Everything else is called by the components themselves on the session token; your code never calls those routes, so they are not in the reference.

Start here

  1. Getting started: sandbox credential, one session route, first component, first employee, in about 15 minutes.
  2. Authentication and sessions: credential custody, scopes and components, refresh, revocation, step-ups.
  3. Environments and sandbox: hosts, synthetic data rules, rate limits.
  4. Errors: the error shape, every code with its meaning and the next action.
  5. Partner API: the routes your server calls, with request and response schemas.

Then the guides, one per journey: Provision a company, Company setup, Employees, Run payroll, Payslips and documents, Events in the page, Webhooks, Usage and audit. And the platform pages: Embedding the React package, Embedding the frame shell, Security model, Going to production, Showcase walkthrough, AI assistants (MCP).

What you do not have to build

Payroll calculation, STP lodgement, super payments, payslips and documents, bank file generation, ATO connection, employee onboarding (tax and super declarations), audit trail and seven-year record keeping. Payroo runs all of it; you integrate the surfaces your customers need.

Who to contact

Partner support reaches you through the e-mails you register on your partner record. Quote the X-Correlation-Id of any response when you write to Payroo; it matches Payroo's audit record for that request.