---
title: "Cancel pay run"
method: POST
path: "/organisations/{organisationId}/pay-runs/{payRunId}/cancel"
tags: ["Organisations", "Pay Runs"]
---

# Cancel pay run

`POST /organisations/{organisationId}/pay-runs/{payRunId}/cancel`

## Request

- Base URL: `https://api.partners.uat.crezco.com`
- URL: `https://api.partners.uat.crezco.com/organisations/{organisationId}/pay-runs/{payRunId}/cancel`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/crezco/apis/payables-api/docs/organisations/:organisationId/pay-runs/:payRunId/cancel/post.ts> (a function with typed inputs; its response is checked against the schema)

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](https://crezco.readme.io/reference/statuses) for details on which statuses are valid for cancellation.

## Path parameters

- `organisationId` string, uuid, required
- `payRunId` string, uuid, required

## Headers

- `Crezco-Version` string

## Response `200`

OK

- CancelPayRunResourceRepresentationVersion3: Response returned by the Cancel Pay Run endpoint on success
  - `status` string, required: <p> Current status of this pay run. See the <a href="https://crezco.readme.io/reference/statuses">Statuses reference</a> in our documentation for a full description of all possible statuses. </p>

## Other responses

- `401`: You do not have access. Check your API key is correct.
- `403`: You do not have access to this organisation.
- `404`: Not Found
- `406`: The 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.
- `409`: Conflict
- `429`: You have made too many requests to the API in too short a period. Wait a while and try again.

---

[API](https://skmtc.dev/crezco/apis/payables-api.md) - [All operations](https://skmtc.dev/crezco/apis/payables-api/llms.txt) - [OpenAPI document](https://skmtc.dev/crezco/apis/payables-api/revisions/4427e79fba09?raw)