Cancel Payment Schedule RESTful API

API Details

In a Fixed-Length schedule the Cancel Payment Schedule request will set the status of any READY_FOR_EXPORT Direct Debit transactions in that schedule to REVOKED.

In an Open-Ended schedule the current READY_FOR_EXPORT payment is updated to CANCELLED and no additional payments will be added.

(See Direct Debit Statuses for more information on the various payment statuses that are possible).


The Idempotency check is only against successful requests, so where a previous call has resulted in any of the following HTTP Response Codes, that Idempotency key may be reused without any issue:

  • 401
  • 403
  • 404
  • 408
  • 500
  • 501
  • 503