Home
Home
  1. Home
  • 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. Home

Welcome

Ontime is a payment method that enables Employees to pay regular bills straight from salary. Employees who pay their bills this way get cheaper prices, access to better products and more control over their finances. Ontime’s Payroll Provider partners get a new way to support their clients’ Employees as well as a new revenue stream.

Who this site is for#

Our developer site is for Developers, QAs and Product Managers from Ontime’s Payroll Provider partners. The site will help you to design and build an API integration with Ontime.

How Ontime works#

Ontime is a payment network, connecting Employees, Billers, and Payroll Providers:
Employees visit a Biller website and sign-up for a product or service.
Billers request payments.
Payroll Providers instruct deductions.
Ontime orchestrates payment receipt and onward transfer to the Biller.
Ontime’s integration with Payroll Providers splits across two parts:
1.
Availability & Onboarding: A Biller asks whether Ontime is available as a payment method for their customer.
2.
Deduction Management: A Biller requests a payment from a customer. Ontime instructs a deduction via the Payroll Provider. On receipt, Ontime processes the payment to the Biller.
Our integration is machine-to-machine: your system talks directly to our system through an API. It is not a website SDK embedded into your front-end user experience. The connection runs in the background between platforms, allowing data to be exchanged automatically and securely.
What you will find
Our APIs are fully documented using OpenAPI (Swagger) specifications, making it seamless to explore and integrate Ontime’s services.
What’s included?
Authentication flows (OAuth2, API keys)
An integration guide for Availability & Onboarding and Deduction Management
OpenAPI specifications containing endpoints and schemas
A reference implementation
Need Help?
We’re committed to supporting your integration journey. If you have any questions, our developer support team is just a message away.
📧 Contact Us: developers@ontime.co
Next
Getting started