Create single schedule

Create a single schedule, which executes a simple payment operation on a single account. Configure the schedule's execution frequency and other details in the schedule_details field.

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 single schedule

string
required
length between 36 and 50

Schedule ID (idempotency field for this operation)

schedule_details
object
required

Single schedule details

int64
required

Account ID

float
required

Credit or debit amount

string
required

Three-letter currency code of the operation in ISO 4217.

string
required

Processing code that identifies the credit or debit operation

string
length ≤ 100

Optional text that describes the operation

restrictions
object

Restrictions applied to the schedule

metadata
object

Any key-value object with custom information

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