Skip to navigation
Transaction APISchedule

Update a schedule

Requires the registrationId of an existing transaction of type Register, Debit-with-register, or Preauthorize-with-register.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

apiKeystringRequired
API Key of Connector
scheduleIdstringRequired
ID of the schedule

Request

Update a schedule with given parameters
registrationUuidstringOptional
amountstringOptionalformat: "^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$"
currencyenumOptional

ISO 4217 three-letter currency code (e.g. EUR, USD, GBP).

periodLengthdoubleOptional>=0
periodUnitenumOptional
Allowed values:
startDateTimestringOptionalformat: "^[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}$"
merchantMetaDatastringOptional
callbackUrlstringOptional

Response

Schedule response
successbooleanOptional
scheduleIdstringOptional
registrationIdstringOptional
oldStatusenumOptional
Allowed values:
newStatusenumOptional
Allowed values:
scheduledAtstringOptionalformat: "^[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}$"
merchantMetaDatastringOptional