Scheduled payments task
A scheduled payment is a payment that is sent to a recipient based on a scheduled payment configuration. When this task runs, it checks all of the scheduled payment configurations and sends only those scheduled payments that are due to be sent. The task also calculates the next payment date for the scheduled payment configurations that had payments that were sent.
A scheduled payment is ready to be sent by the task when its scheduled date is either on or before the date that the task is running on. After the payment is sent, the task calculates the next scheduled date for the scheduled payment. If the next scheduled date is past the ending date of the scheduled payment configuration, or if the number of sent payments is the same as the number of payments that were configured to be sent, the task updates the scheduled payment configuration to be complete.
If the task did not run for several days, it sends a payment for each of the scheduled payment configurations that were missed. A missed payment is one that has a next scheduled date that is before the current date that the task is running on. After a missed payment is sent, the task calculates the next scheduled date for that missed scheduled payment. If the new date is still in the past, it does not send another payment. Instead, the task uses the date that the task is running on to calculate the next scheduled date for the scheduled payment that was missed.
- A single, or one time, payment.
- A weekly payment.
- A monthly payment.
- A scheduled payment is configured to be sent every Friday. The task sends a payment on 10 August 2018 and then updates the next scheduled date for the scheduled payment to be 17 August 2018.
- A scheduled payment is configured to be sent on the 15th of every month. The task sends a payment on 15 September 2018 and then updates the next scheduled date for the scheduled payment to be 15 October 2018.
- A scheduled payment is configured as a one-time payment to be sent on 22 December 2018. The task sends the payment on 22 December 2018 and then updates the scheduled payment configuration to be completed.
- A scheduled payment is configured to be sent every Tuesday until 28 August 2018. The task sends a payment on 28 August 2018. The next scheduled date is determined to be 4 September 2018, which is after the ending date of 28 August 2018. The task updates the scheduled payment configuration to be completed.
- A scheduled payment is configured to be sent on the 10th of every month for 12 months. The task sends a payment on 10 December 2018 and then determines that this payment is the 12th time that the scheduled payment was sent. The task updates the scheduled payment configuration to be completed.
Notifications
- Upcoming payment notification
- The task notifies the user when scheduled payments are upcoming. When the user receives this notification,
they can modify an upcoming scheduled payment if necessary. For example, the user might need to update the
scheduled payment to change the amount, to skip the next payment, or to change some other aspect of the
scheduled payment.
The task uses its current run time and the Transaction Notification Days parameter to determine which active scheduled payment configurations have upcoming payments that require notification.
- The scheduled payment configuration is complete
- After the last payment for a scheduled payment configuration is sent, the task notifies the user that the scheduled payment configuration is complete. The configuration is complete when either its ending date is passed or the configured number of scheduled payments were sent.
- Scheduled payment could not be sent
- The task notifies the user when it cannot send a scheduled payment.
End of day processing
During the end of day processing, the task finds any scheduled payment configurations that are not active. Each of these configurations is removed from the FTM database unless payments that are related to the configuration still exist. When payments that are related to a non-active scheduled payment configuration still exist, the configuration remains in the FTM database.
Configuring the task
The task configuration parameters are used to identify the payment scheme for the scheduled payments that are sent by the task and to control when the upcoming payment notifications are sent. The parameters are described in Scheduled payments task configuration parameters.
Scheduling the task
After the scheduled payments task is configured, consider scheduling the task to run daily so that scheduled payments are sent every day.
For more information about creating a scheduled configuration for a task, see New Scheduled Configuration.