Create transfer schedule

Create a transfer schedule, which represents a transfer operation from a parent (main) account to one or more associated child accounts. Configure the schedule's execution frequency and other details in the schedule_details field.

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.

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request processing body

Request to create a new transfer schedule

string
required
length between 36 and 50

Schedule ID (idempotency field for this operation)

schedule_details
object
required

Transfer schedule details

string
length ≤ 100

Optional text that describes the operation

string
enum

If the strategy field is not specified, you must provide the amount field for each transfer in the transfers array. The following strategy types determine the transfer amounts when a strategy is specified.

  • SWEEP: Transfers the entire balance from the child account to the parent account. The terms "parent" and "child" refer to account roles, but no relationship validation is performed.

    Child → Parent

  • OVERDRAFT_SWEEEP: Follows the same logic as SWEEP, except when a child account is negative, in which case the main account sends enough money to zero out the child account.

    Parent → Child

Allowed:
transfers
array of objects
required

List of transfers, including their origin and destination accounts. The amount field must be provided if the strategy is not specified.

transfers*
Responses

400

Bad request

403

Operation forbidden

500

Internal server error

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json