Home
Home
  1. Getting started
  • Welcome
  • Getting started
    • Availability and Onboarding
      • Light Availability Check
      • Full Availability Check
      • Onboarding
    • Salary Deduction
      • Deduction Instruction
      • Re-running Payroll
      • Deduction Payments and Reconciliation
      • Changes to Employee Status
  • API Reference
    • Authentication
    • Idempotency
    • Webhooks
      • Webhooks
    • Salary Deduction
      • Salary Deduction Data Request
      • Salary Deduction Confirmation Submission
  • Payroll Provider Reference Implementation
    • Light Availability Check
      POST
    • Full Availability Check
      POST
    • Salary Deduction Enablement
      POST
    • Payroll Information
      GET
    • Salary Deduction Employee Data Push
      POST
  • Schemas
    • Availability Check
      • Full Availability Check Request
      • Full Availability Check Response
      • Light Availability Check Request
      • Light Availability Check Response
    • Core
      • ProblemDetails
      • MetaData
      • Paged Response
    • Deduction Instructions
      • Salary Deduction Request
      • Salary Deduction
      • Confirmation Deduction Response
      • Salary Deduction Enablement Response
      • Employee Deduction Push Response
      • Employee Deduction Push Request
      • Salary Deduction Push
      • InstructionFile
      • InstructionItem
    • Payment Account
      • Payment Account
      • Payment Information
    • Payroll
      • Employee
      • Availability Payroll
      • Availability Employment
      • Availability Employer
      • BeneficiaryAccountResponse
      • Salary Deduction Confirmation Data Submission
      • Salary Deduction Confirmation Data Submission Response
      • Salary Deduction Data Request
      • Salary Deduction Data Response
      • Payroll
      • Employee Payroll
      • Employment
      • Employer
      • Pay Date
      • Salary Deduction Enablement Request
      • PayrollScheduleResponse
    • Webhooks
      • Employee Update Payload
      • WebHook
  1. Getting started

Salary Deduction

About Salary Deduction#

Once an Employee has agreed to Ontime's T&Cs, the Biller can request payments via Ontime. Ontime then requests that the Payroll Provider instructs the payments as deductions. On payday, once the employer has sent the funds to Ontime, Ontime reconciles the payment.
Ontime has worked together with others to design an approach for implementing payroll deductions that enables Payroll Providers to support a solution-agnostic interface for multiple commercial propositions.

Flows#

Deduction Instruction: Instruct deductions into a pay run
Re-running Payroll: Manage exceptions when Payroll is re-run.
Deduction Payments and Reconciliation: Confirm and verify payments and reconciliation
Changes to Employee Status: Updates Ontime with key changes to an Employee status (e.g. Leaver)
Reference implementations
Payroll Provider Reference Implementation
Scope
Notwithstanding the reference implementations there may be product-specific requirements which are out of scope for this document.
Contact payroll@ontime.co for information about how we can support your unique requirements.

Overview#

Flows#

There are four main flows:
Deduction Instruction
Ensure that deduction instructions are supplied to the Payroll Provider are verified and processed in a timely manner.
Provide confirmation of payment processing.

Deduction Instruction Documentation#

Re-running Payroll
Manage exceptions when Payroll is re-run.

Payroll Documentation#

Deduction Payments and Reconciliation
Confirm and verify payments and reconciliation

Payments and Reconciliation Documentation#

Changes to Employee Status
Updates Ontime of key changes to an Employee status.
For example:
Left Payroll
Migrated from Payroll
Employee Status Updates#
Previous
Onboarding
Next
Deduction Instruction