# Cancel check

Cancel a check using the provided check ID.

**NOTES**:
- This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message.

This endpoint generates the following events:
- [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1)
- [Check posting status change](https://developers.pismo.io/events/docs/cash-management-check-status-change-1)

See [Data and reporting](doc:data-reporting-overview) for more information about events and setting up event notifications.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Banking - Transaction banking",
    "version": "0.9.0",
    "description": "Transaction banking API",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Check posting",
      "description": "Check posting endpoints"
    }
  ],
  "components": {
    "parameters": {
      "CheckIDPath": {
        "name": "checkId",
        "in": "path",
        "description": "Check ID",
        "schema": {
          "type": "string"
        },
        "required": true,
        "example": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72"
      }
    },
    "schemas": {
      "CheckCancelResponse": {
        "type": "object",
        "required": [
          "check_id"
        ],
        "properties": {
          "check_id": {
            "$ref": "#/components/schemas/CheckId"
          }
        },
        "description": "Response for check cancel."
      },
      "ErrorCode": {
        "description": "Error code\n`minLength: 1`\n`maxLength: 12`\n",
        "type": "string",
        "minLength": 1,
        "maxLength": 12,
        "example": "WPMT0017"
      },
      "ErrorMessage": {
        "description": "Error message\n`minLength: 1`\n`maxLength: 1000`\n",
        "type": "string",
        "minLength": 1,
        "maxLength": 1000,
        "example": "Invalid JSON payload received: Error unmarshalling request"
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ErrorCode"
          },
          "message": {
            "$ref": "#/components/schemas/ErrorMessage"
          }
        }
      },
      "CheckId": {
        "type": "string",
        "description": "Check ID.",
        "maxLength": 60,
        "minLength": 1,
        "pattern": "^[a-zA-Z0-9-]+$",
        "example": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72"
      }
    },
    "responses": {
      "401Unauthorized": {
        "description": "Access token is missing or invalid"
      },
      "403Forbidden": {
        "description": "The request has been lost"
      },
      "500InternalServer": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Generic internal error": {
                "value": {
                  "code": "ECMN9999",
                  "message": "Internal error"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "paths": {
    "/corporate/v1/checks/{checkId}/cancel": {
      "post": {
        "summary": "Cancel check",
        "description": "Cancel a check using the provided check ID.\n\n**NOTES**:\n- This endpoint requires an account token - an access token encoded with an external account ID. Tokens can expire quickly, which can result in a `401 Unauthorized` message.\n\nThis endpoint generates the following events:\n- [Platform authorization created](https://developers.pismo.io/events/docs/platform-authorization-platform-authorization-1)\n- [Check posting status change](https://developers.pismo.io/events/docs/cash-management-check-status-change-1)\n\nSee [Data and reporting](https://developers.pismo.io/pismo-docs/docs/data-reporting-overview) for more information about events and setting up event notifications.",
        "operationId": "post-corporate-v1-checks-checkId-cancel",
        "tags": [
          "Check posting"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/CheckIDPath"
          }
        ],
        "responses": {
          "202": {
            "description": "Check cancel accepted",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckCancelResponse"
                },
                "example": {
                  "check_id": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "check_id max": {
                    "summary": "check_id exceeds maximum length",
                    "value": {
                      "message": "check_id must be a maximum of 60 characters in length",
                      "code": "WCPT0002"
                    }
                  },
                  "Corporate Account Not Found": {
                    "summary": "Corporate account not found",
                    "value": {
                      "code": "WCPT0004",
                      "message": "Corporate account not found"
                    }
                  },
                  "Operations Blocked": {
                    "summary": "Operations blocked",
                    "value": {
                      "message": "Operations blocked for account",
                      "code": "WOBK0007"
                    }
                  },
                  "Invalid Check Status": {
                    "summary": "Invalid check status",
                    "value": {
                      "message": "Check status is invalid for this operation",
                      "code": "WCPT0011"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/403Forbidden"
          },
          "404": {
            "description": "Check posting not found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    },
                    "code": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "message": "Check posting not found",
                  "code": "WCPT0003"
                }
              }
            }
          },
          "409": {
            "description": "Tracking ID already exists",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    },
                    "code": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "message": "Tracking ID already exists for another operation",
                  "code": "WCPT0013"
                }
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/500InternalServer"
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ]
      }
    }
  }
}
```