Skip to main content




Start a schedule.

Requires the registrationId of an existing transaction of type Register, Debit (withRegister), or Preauthorize (withRegister).

Rate limit

Please be aware of the rate limit for this API endpoint:

  • Total limit: Each unique API user is limited to to 60 requests per 60-second window.

If these limits are exceeded, the server will respond with a HTTP 429 status code, indicating too many requests. Please ensure to manage your requests within these limits to maintain uninterrupted service.


Path Parameters

    apiKey stringrequired

    Possible values: <= 50 characters

    API Key of Connector



Start a schedule on the given registration transaction

    registrationUuid stringrequired

    Possible values: <= 50 characters

    amount string

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Decimal amount separated by ., maximum of 3 decimals.

    currency string

    Possible values: Value must match regular expression ^[A-Z]{3}$

    ISO 4217 three-letter currency code.

    periodLength integer
    periodUnit PeriodUnit

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The unit that the duration is measured in.

    startDateTime date-time

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$

    RFC 3339 Internet Date/Time Format date-time

    merchantMetaData string

    Possible values: <= 255 characters

    callbackUrl string

    Possible values: <= 4096 characters

    Callback URL for sending notifications of transactions initiated by the schedule, instead of the URL from the Register transaction.


Schedule response

    success stringrequired

    Possible values: [false, true]

    errorMessage string

    Error message.

    While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

    errorCode int32
    adapterMessage string
    adapterCode string
    property name* any