Cancel Rate Lock

Pricing engine integrations can request to cancel a confirmed lock by implementing the CANCEL action supported by our custom transaction result operations. The CANCEL action uses a comment attribute, where the integration can provide cancellation reasons or other free form text they would like to be recorded.

Below is the JSON-schema specification for the CANCEL transaction results details object:

  "$schema": "",
  "type": "object",
  "properties": {
    "comments": {
      "type": "string",
      "description": "Reason for cancellation"
  "required": [
  "additionalProperties": false


Rate lock CANCEL operation constraints

The CANCEL result action can be performed only if there is a confirmed rate lock on the subject loan. If the loan does not have a confirmed rate lock, the cancel request is not applicable and will error out.

Below is a sample payload for the cancel request operation:

  "status": "completed",
  "result": {
    "format": "application/vnd.productpricing-cancellock-1.0.0.json",
    "action": "CANCEL",
    "details": {
      "comments": "Cancelling lock, as borrower changed their mind"