Cancel pay run

post https://api.partners.sandbox.crezco.com/organisations/{organisationId}/pay-runs/{payRunId}/cancel

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.

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.partners.sandbox.crezco.com/organisations/organisationId/pay-runs/payRunId/cancel \
3
     --header 'Crezco-Version: 2025-01-31' \
4
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "status": "Created"
3
}

200OK

401You do not have access. Check your API key is correct.

403You do not have access to this organisation.

404Not Found

406The version of the API that you requested is not available. Check your Crezco-Version header. If you omit this header you will use the latest version of the API.

409Conflict

429You have made too many requests to the API in too short a period. Wait a while and try again.