---
updatedAt: 2026-02-12T19:58:16.000Z
agentTools:
  projectIndex: https://docs.withreach.com/llms.txt
---

# /cancel

Cancel a pre-authorized order. This requires that payment has not been captured.


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.22",
    "title": "Reach Checkout API",
    "contact": {
      "email": "support@withreach.com"
    },
    "description": "June 2022 <br>withreach.com<br>docs.withreach.com<br><br> Reach's Checkout API provides suppliers the ability to execute and manage payment processing for consumer orders while retaining control over the shopper experience and limiting PCI DSS exposure. Creating payment orders, refunding payments, and querying available foreign exchange rates and payment methods are all provided by this JSON-based API.\n"
  },
  "servers": [
    {
      "description": "Reach Sandbox",
      "url": "https://checkout.rch.how/v2.22"
    },
    {
      "description": "Reach Dev",
      "url": "https://checkout.rch.red/v2.22"
    }
  ],
  "paths": {
    "/cancel": {
      "post": {
        "operationId": "cancel",
        "description": "Cancel a pre-authorized order. This requires that payment has not been captured.\n",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "allOf": [
                  {
                    "type": "object",
                    "required": [
                      "request",
                      "signature"
                    ],
                    "properties": {
                      "request": {
                        "type": "object",
                        "required": [
                          "MerchantId",
                          "OrderId"
                        ]
                      },
                      "signature": {
                        "description": "Computed SHA256 HMAC value of the `request` JSON object (before any encoding) using the shared secret provided by Reach. See  [Signature Calculation](https://docs.withreach.com/docs/signature-calculation) for more details.\n",
                        "type": "string"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "request": {
                        "type": "object",
                        "properties": {
                          "MerchantId": {
                            "description": "The 36 character GUID which identifies the supplier to the Reach system.\n",
                            "type": "string",
                            "format": "uuid"
                          }
                        }
                      }
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "request": {
                        "type": "object",
                        "properties": {
                          "OrderId": {
                            "description": "The 36 character GUID which identifies the order in the Reach  system.\n",
                            "type": "string",
                            "format": "uuid"
                          }
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The order was successfully cancelled in the Reach system.\n",
            "content": {
              "x-www-form-urlencoded": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "OrderId": {
                      "description": "The Reach order identifier specified in the request.\n",
                      "type": "string",
                      "format": "uuid"
                    }
                  },
                  "required": [
                    "OrderId"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "If present, the cancel request structure was invalid and unable to be parsed.\n"
          },
          "404": {
            "description": "If present, a value of the request was unable to be found. For example, if the MerchantId provided could not be found in the given environment\n"
          },
          "503": {
            "description": "There was a system problem and the request should be tried again.\n"
          },
          "2XX": {
            "description": "If present, the order could not be cancelled due to an error. An HTTP 200 status code will be returned to indicate that the request was structured properly but an error was encountered.\n",
            "content": {
              "x-www-form-urlencoded": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Error": {
                      "description": "If there was an error when processing a POST request this is the error structure returned.\n",
                      "type": "object",
                      "properties": {
                        "Code": {
                          "description": "A request-specific error code, described in the Error Codes section for the specific request.\n",
                          "type": "string"
                        },
                        "ReasonCode": {
                          "description": "A short description of the error.\n",
                          "type": "string"
                        }
                      },
                      "required": [
                        "Code"
                      ]
                    }
                  },
                  "required": [
                    "Error"
                  ]
                }
              }
            }
          }
        },
        "tags": [
          "POST"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "POST"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  },
  "x-samples-enabled": false
}
```