Schedule Management

Provision has been made to manage schedules. All of these facilities require knowing the schedule identifier for the schedule being considered or manipulated. This will have been provided on creation and can be found associated with the transactions that it has been assigned against or triggered.

View a schedule

Retrieve details about the schedule. This facility is for viewing the details around the schedule configuration, not the details around the scheduled transactions. Transactions should be viewed via the existing schedule reporting mechanisms.

See the Get a schedule endpoint definition.

View next episode

Retrieve details about the next episode on schedule. This includes the episode due date and the amount.

See the Get the next episode endpoint definition.

Cancel a schedule

This allows the schedule to be canceled so that it no longer runs and customer funds are not withdrawn. Once a Schedule has been canceled it cannot be resumed, for a temporary interruption you should suspend the schedule.

See the Cancel a schedule endpoint definition.

Suspend a schedule

This allows the schedule to be suspended so that it is not run until resumed.

See the Suspend a schedule endpoint definition.

Resume a schedule

This allows the schedule that has been suspended to be resumed a schedule so that processing of transactions will continue. There is an option to 'catch up' and process any scheduled transactions that would have been processed had the schedule not been suspended.

See the Resume a schedule endpoint definition.

Update a schedule

Update a schedule definition. This allows for changing how episode dates are determined, change when the schedule will end, or to change the reference date episodes are calculated from.

The request must contain the full schedule definition, as it is completely replaced with the new definition. For example if the schedule has a terminator, and the update request does not, then the schedule will be updated to have no terminator.

After updating the schedule, it is recommended to retrieve the schedule (GET /acceptor/rest/schedules/{instId}/{scheduleId}) and/or the next episode (GET /acceptor/rest/schedules/{instId}/{scheduleId}/next) to ensure the update has had the desired effect.

See the Update a schedule endpoint definition.