Audience – Backend engineers integrating Ontime’s Test & Learn ➜ Consumer Management domain. Curl snippets are provided for quick terminal testing.
Core Operations at‑a‑Glance#
| Operation | Purpose | Typical Flow |
|---|
| Availability Check | Verify that a consumer’s payroll supports salary‑deduction before you onboard them. | POST /availability → status |
| Mandates | Create a legally‑binding authority allowing Ontime to deduct funds from payroll on your behalf, or cancel when no longer needed. | POST /mandates → mandate_id & DELETE /mandates/{id} |
| Payment Requests | Instruct a one‑off payroll deduction or withdraw a request that is not yet in flight. | POST /payments → payment_id & DELETE /payments/{id} |
| Payouts | Retrieve payout reports detailing bank transfers made from Ontime to you | GET /payouts/{payout_reference} & /payouts |
A Payment Requests is 'in flight' whilst it is being actively processed by the Payroll Provider.
Base URLs & Environments#
Process Sequence#
