Returns the status and per-payroll results of a payroll cancellation batch.

Poll this endpoint until the batch status reaches a terminal value (completed or failed). Once terminal, the response includes the results array (one entry per authorized payroll, each with its own per-payroll status — success or failed) and the exclusions array (one entry per payroll that could not be processed). A cancel is atomic, so a per-payroll result is only ever success or failed — never partial_success.

Note that the top-level batch status (pending / processing / completed / failed) is the request lifecycle, distinct from the per-payroll status inside results[]. A completed batch does not imply every payroll was cancelled — inspect the array for per-payroll outcomes.

Results are stored in Redis with a limited TTL after completion. If the partner polls after results have expired, this endpoint returns 410 Gone — partners should re-submit a new batch.

📘 System Access Authentication

This endpoint uses the Bearer Auth scheme with the system-level access token in the HTTP Authorization header

scope: payroll_batches:read