Create bulk transfer schedules

Create multiple transfer schedules in a single request. This request triggers an asynchronous process to create the schedules. Once processing is complete, the Bulk transfer schedules created event is sent with the result of the operation.

This endpoint accepts a defaults object that can be used to set common values for all schedules in the request. Individual schedules can override any default value by specifying the field in their own definition.

Transfer amounts can be set as follows.

• If you fill out the strategy field, the platform uses the strategy logic to determine transfer amounts.
• If you don't fill out the strategy field, you must specify the amount field for each transfer in the transfers array, or provide a default amount in transfer_defaults.

In some cases, due to errors and retries, execution of the scheduled transaction might occur on the following day instead of the originally scheduled date. To address this, the allow_execution_after_day_change flag in schedule_details enables you to pre-authorize execution of the scheduled transaction on the next day. This flag must be set to true for schedules that are set to be executed at the end of the day (after 11:30pm UTC). If the schedule is not executed on the expected day for any reason, and this field isn't set to true, the schedule is not executed and is marked as EXECUTED_WITH_ERROR_NEXT_DAY_NOT_ALLOWED.

This endpoint generates the Scheduled payment created or modified event with the status field set to CREATED.

Each execution of the schedule also generates the Scheduled payment executed event.

Refer to the Payment scheduler guide for more information.