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

Mandates

A mandate is a digital, legally‑binding authority that empowers Ontime to instruct the consumer’s employer to deduct funds from their salary on your behalf. Every payment request must reference an active mandate;.

Key points & cautions#

Capture explicit consent – We expect you to present Consumers with a checkbox confirming their consent to salary deduction AND we expect you to include our T&Cs within yours, which the consumer will also need to accept. We will ask you to provide us with an authorisation source in your request to create a new mandate to confirm this.
MandateRecordRequest

Use Idempotency-Key – always supply the same header value when retrying Create Mandate. This prevents accidental duplicates and ensures safe, repeatable requests.
Respect limitation tightness – you may customise maximum_payment_amount or percentage_of_payment_amount_accepted on mandate creation; in order to raise or relax them a new mandate must be created.
Cancellation is final – DELETE /mandates/{id} irreversibly revokes payroll authority. To resume deductions you must create a new mandate.
A consumer can have multiple active mandates as required - for example for different products.
Handle PII & tokens securely – National Insurance numbers and JWTs are sensitive; hash or redact them in logs and monitoring tools.

Webhooks#

Ontime sends webhooks based on key events. For Mandates these are:
Mandate created/updated
Previous
Payment Management
Next
Create a new mandate