Home
Home
  1. Home
  • Welcome
    • About Ontime
    • Overview
    • Test and Learn Projects
  • Authentication
  • Availability Check
    • Light Availability Check
      POST
    • Full Availability Check
      POST
  • Payment Management
    • Mandates
      • Create a new mandate
      • Cancel an existing mandate
      • Get a Mandate
      • Get many Mandates
    • Payment Requests
      • Instruct a new payment request
      • Cancel an existing payment request
      • Get a Payment
      • Get many Payments
  • Payouts
    • Get a Payout
      GET
    • Get Available Payouts
      GET
  • Webhooks
    • Mandate Created/Updated
    • Payment Request Created/Updated
    • Payout Created
  1. Home

Overview

Process Overview#

Prerequsities:#

1
Check the consumer's availability
Submit the consumer's National Registration Number (NRN) – perform a Full Availability Check with the consumer’s NRN. Ontime confirms whether the employee is managed by a Payroll Provider within our network.
2
Branch on the result
Not found – The consumer’s employer is outside Ontime’s Payroll Provider network; use an alternative payment method such as a direct debit.
Found – Salary‑deduction is supported; proceed to the next step.

Create the payment mandate and request:#

1
Create a Mandate
With a positive availability result, issue a Mandate capturing the consumer’s explicit consent to allow us to collect payments and any collection limits. On creation a unique mandate_id is returned.
2
Raise a Payment Request
Use the mandate_id to create a Payment Request for the amount you wish to collect. Ontime schedules the deduction for the next payroll cycle and return a payment_id.
3
Iterate or Exit
Repeat the previous two steps to request additional payments while the mandate is active.
Mandates and Payment Requests cannot be modified after they have been created. To make changes to a Mandate or Payment Request the original needs to be cancelled and a new Mandate or Payment request must be created.
You cannot cancel a Payment Request whilst the payment is being processed by Ontime.
Cancelling a Mandate cancels all outstanding Payment Requests that can be cancelled and stops new Payment Requests from being created.
Previous
Full Availability Check
Next
Mandates