What's New
CancelSchedule and RestartSchedule Endpoints for contract schedules
If you use the DDCMS API to manage contracts, you can now cancel and restart contract schedules programmatically, without needing to log in to the DDCMS interface. These new endpoints provide the same functionality as the Cancel and Restart actions available in the DDCMS UI, making it straightforward to manage the status of contract schedules via your own systems.
Overview
Two new POST endpoints have been introduced:
CancelSchedule — stops scheduled payments on an active contract schedule by setting its status to Terminated.
RestartSchedule — resumes scheduled payments on a terminated contract schedule by setting its status back to Active.
Prerequisites
Before using the API endpoints, please ensure the following:
You have a valid API key for your client (provided by the onboarding or support team).
You know your client prefix (provided in your welcome email).
Authentication
All requests must be authenticated using an API key, passed as a header in your request:
apiKey: {apiKey}
Cancel a Contract Schedule
Send a POST request to cancel an active contract schedule. Once cancelled, scheduled payments on that schedule will stop.
Endpoint: POST {ddcmsurl}/api/v3/client/{clientPrefix}/contract/{contractId:Guid}/cancelSchedule
input params: only contractId in the URL
Parameter | Description |
contractId | The unique identifier of the contract schedule you wish to cancel. |
On success, the endpoint returns a 200 OK response with Contract schedule was cancelled successfully.
Restart a Contract Schedule
Send a POST request to restart a cancelled contract schedule. Once restarted, scheduled payments on that schedule will resume.
Endpoint: POST {ddcmsurl}/api/v3/client/{clientPrefix}/contract/{contractId:Guid}/restartSchedule
input params: only contractId in the URL & nullable comment as a query parameter
Parameter | Description |
contractId | The unique identifier of the contract schedule you wish to restart. |
On success, the endpoint returns a 200 OK response with the Contract schedule was restarted successfully.
HTTP Response Codes
Both endpoints return standard HTTP status codes. The table below summarises the possible responses:
HTTP Status | Scenario |
200 OK | Contract schedule was cancelled successfully. Contract schedule was restarted successfully. |
400 Bad Request | {specific error message} |
403 Forbidden | This contract cannot be used in API. When contract is protected. |
404 Not Found | Contract with the specified ID does not exist. |
500 Internal Server Error | An unexpected error occurred while processing the request. |
API Documentation
Full API specification for these endpoints, including request/response schemas and samples, will be available in the DDCMS API documentation upon deployment: