Start
POST/schedule/:apiKey/start
Start a schedule.
Requires the registrationId of an existing transaction of type Register, Debit (withRegister), or Preauthorize (withRegister).
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.
Request
Responses
- 200
- 429
Schedule response
Rate limit exceeded
Callbacks
- POST statusChange
POST{$request.body#/callbackUrl}
Receive status updates about transactions.
Status changes are posted as callbacks to the callbackUrl defined in the request.
See the Callbacks reference for further information about callbacks.
Callbacks Responses
- 200
- 500
Reply with status 200 and body OK if you have received the callback successfully.
Callback processing failed and retries will be performed.
See the Response handling — Acknowledging callback receipt reference for further information.