Purpose — A schedule instructs Ontime to deduct a multiple future payment requests. Based on the information provided, Ontime will select the most appropriate pay cycle to cover the expectation and satisfy the requested due date.
Key points & cautions#
Mandate required – the mandate_id you supply must be active; otherwise you receive 403 Forbidden.Idempotency = safety – include Idempotency-Key on every call. Resending the same body + key is safe and will never double‑charge.Allow Post Due Date Deduction – when making your request you can opt to allow post due date deductions. This means that if the next payroll date falls after your due date, Ontime still collects and remits funds at the earliest possible payout. By default this is set to false, meaning that if the next payroll date falls after your due date, Ontime will reject the payment request.Cancellation window – you may DELETE a schedule at any point after it becomes 'Active'. Ontime will attempt to cancel all related payment requests with a future due date. If Ontime is unable to cancel any payment request (e.g. the payroll cut off has passed) then they will remain but the overarching schedule will be cancelled alongside any payment requests which can still be cancelled.Schedule Validation - it is highly recommended that the first date in your schedule be 30 days or more from today in order to allow for the current pay cycle. If we are unable to make the first deduction then the schedule creation will fail.