post https://sandbox.pismolabs.io/scheduler-payments/v1/pre-schedules
Create a pre-schedule, which is a type of schedule that gets executed by a direct call from the Pismo platform at the end of the closing cycle. To configure execution of a pre-schedule, contact your Pismo representative.
This endpoint generates the Scheduled payment created or modified event with the status
field set to CREATED
.
Once the pre-schedule is created, its execution generates the following events.
- First execution of the pre-schedule on the start date generates the Scheduled payment created or modified event with the
status
field set toIN_PROGRESS
. - Last execution of the pre-schedule on the end date generates the Scheduled payment created or modified event with the
status
field set toCOMPLETED
. - Each execution of the pre-schedule also generates the Scheduled payment executed event with the corresponding execution status.
Refer to the Payment scheduler guide for more information.