---
title: "Start a schedule. Requires the registrationId of an existing transaction of type Register / Debit-with-register / Preauthorize-with-register"
method: POST
path: "/schedule/{apiKey}/start"
tags: ["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`
- URL: `https://gateway.tillpayments.com/api/v3/schedule/{apiKey}/start`
- 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)

## Path parameters

- `apiKey` string, required

## Request body

- StartSchedule
  - `registrationUuid` string, required
  - `amount` string
  - `currency` string
  - `periodLength` number
  - `periodUnit` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
  - `startDateTime` string
  - `merchantMetaData` string
  - `callbackUrl` string

## Response `200`

Schedule response

- ScheduleResponse
  - `success` boolean
  - `scheduleId` string
  - `registrationId` string
  - `oldStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'ERROR' | 'CREATE-PENDING'
  - `newStatus` 'ACTIVE' | 'PAUSED' | 'CANCELLED' | 'ERROR' | 'CREATE-PENDING'
  - `scheduledAt` string
  - `merchantMetaData` string

---

[API](https://skmtc.dev/tillpayments/apis/till-payments-gateway.md) - [All operations](https://skmtc.dev/tillpayments/apis/till-payments-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/tillpayments/apis/till-payments-gateway/revisions/42c40d316a83?raw)