API Reference
Log In
API Reference

Cancels a pay run which has not yet been started. A pay run may only be cancelled if the following conditions are met:

  • The pay run exists within the system
  • The pay run is in a state that is valid for cancellation

We are unable to cancel pay runs which have been processed or are in progress. See the Statuses documentation for details on which statuses are valid for cancellation.

If successful, the returned status will usually be Cancelling or Cancelled. Use Get pay run to check the individual Payable statuses, and see Payment Statuses for more details.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!