schedule

Start a schedule. Requires the registrationId of an existing transaction of type Register / Debit-with-register / Preauthorize-with-register

post/schedule/{apiKey}/start

Request

Base URL
https://gateway.tillpayments.com/api/v3
Auth
HTTP basic
TypeScript
https://skmtc.dev/tillpayments/apis/till-payments-gateway/docs/schedule/:apiKey/start/post.ts
A function with typed inputs. Its response is checked against the schema.

apiKeystring required

API Key of Connector

registrationUuidstring required

amountstring

currencystring

periodLengthnumber

periodUnit'DAY' | 'WEEK' | 'MONTH' | 'YEAR'

startDateTimestring

merchantMetaDatastring

callbackUrlstring

Schedule response

successboolean

scheduleIdstring

registrationIdstring

oldStatus'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'ERROR' | 'CREATE-PENDING'

newStatus'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'ERROR' | 'CREATE-PENDING'

scheduledAtstring

merchantMetaDatastring

No recorded changes to this operation across all 4 revisions of this API.