Scheduled Payments
Schedule payments to occur at a recurrence.
You may create and cancel schedules via Deliver.
How to Create a Schedule
Create a Recurrence Rule (RRule)
Create a recurrence rule using the recommended generator here.
Create the Schedule Request
Create a schedule using our POST /schedules API.
Get the Response
See below for the expected response upon creating a schedule.
A few things to note after creating a schedule:
Orum will kick off scheduled transfers at 9am ET. However, if a schedule is created after 9AM ET and is set to start same day - it will kick off right after schedule creation
If a payment date falls on a Bank Holiday, ASAP eligible payments (RTP/FedNow) will process as normal. However, ACH payments will be executed on the immediate Next Business Date
For all transfers created from a schedule, the “schedule_id” will be displayed in the transfer response - as seen below:
How to Cancel a Schedule
Locate the Schedule ID
Locate the unique schedule ID of the schedule by using GET /schedules.
Request Cancel Schedule with the Schedule ID
Call the Cancel Schedule API.
Was this page helpful?