Home
Home
  1. Availability and Onboarding
  • Salary Deduction
    • 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
    • Schemas
      • Availability Check
        • Light Availability Check Response
        • Light Availability Check Request
        • Full Availability Check Response
        • Full Availability Check Request
      • Core
        • ProblemDetails
      • Deduction Instructions
        • Salary Deduction
        • Confirmation Deduction Response
        • Salary Deduction Enablement Response
        • Employee Deduction Push Response
        • Employee Deduction Push Request
        • Latest Employee Deduction Push Response
      • Payment Account
        • Payment Account
        • Payment Information
      • Payroll
        • Salary Deduction Confirmation Data Submission
        • Salary Deduction Data Response
        • Payroll
        • Employee Payroll
        • Employment
        • Pay Date
        • Salary Deduction Enablement Request
      • Webhooks
        • Employee Update Payload
        • WebHook
  • Payroll Provider API Prototypes
    • Light Availability Check
      POST
    • Full Availability Check
      POST
    • Salary Deduction Enablement
      POST
    • Payroll Information
      GET
    • Salary Deduction Employee Data Push
      POST
    • Latest Salary Deduction Employee Data Push
      GET
  1. Availability and Onboarding

Onboarding

About Onboarding#

For a Biller to instruct payments via Ontime, they must first create a mandate against the Employee. The mandate serves as a record of when the Applicant/Employee gave permission for the Biller to take payments via Ontime.

Assumptions and prerequisites#

The Applicant has previously been found as an active Employee within the workforce of a Payroll Provider’s client.

Flow#

Overview#

Steps#

1

Employee instructs salary deductions as a payment method#

Requirements
Biller creates a Payment Mandate with Ontime to allow future Payment Requests to be submitted and cleared via Salary Deduction.
As part of the contract with a Biller, the Employee MUST agree to Ontime’s Terms and Conditions and Privacy Policy.
As part of the Biller's customer journey the Employee MUST give explicit confirmation that they agree to deductions being made from their net salary in order to make payments to Biller.
This clause is also included in the Ontime Terms and Conditions.
2

Ontime onboards the Applicant and links to the Employee record held by the Payroll Provider#

Requirements
Ontime calls the Payroll Provider Platform with legal agreement date stamp for enabling salary deduction:
Salary Deduction Enablement Request

API Documentation
To help accelerate Payroll Provider adoption and implementation a reference RESTful specification is available here:
Salary Deduction Enablement
3

Payroll Provider returns Payroll data to Ontime#

Requirements
The Payroll Provider responds by providing core information about the Employee:
Salary Deduction Enablement Response

Previous
Full Availability Check
Next
Salary Deduction