Rate Lock (v2)

An integration listed under the Product & Pricing Engine (PPE) category can request an interest rate lock by creating a transaction with a response that returns the required field values, and with a response result object with the action LOCK. Within the same transaction response, the integration can also send additional loan data to be updated in Encompass. The specific fields that are sent as part of the response loan data follow the standard data entitlement model and process. However, not all of the loan data fields that are sent inside the loan attribute are saved as part of the lock snapshot.

📘

Schema versions

This page documents application/vnd.productpricing-lock-2.0.0.json. Compared with the 1.x versions, version 2.0.0:

  • Groups the lock fields into side objects: requestSide, buySide, sellSide, and comparisonSide.
  • Uses ISO 8601 dates in YYYY-MM-DD format instead of MM/DD/YYYY.
  • Replaces the single adjustments array with typed arrays such as baseRateAdjustments, basePriceAdjustments, baseMarginAdjustments, lockExtensionAdjustments, reLockFeeAdjustments, and customPriceAdjustments. Each adjustment has priceAdjustmentTypeIndex, description, and rate.
  • Uses different field names within each side, for example numberOfDays and lockExpires. Use the schema on this page as the reference for v2 field names.
  • Replaces stringValue, numericValue, and dateValue in additionalFields items with a single value.

To use this version, make sure the format is included in the formats registered for the LOCK action in your product entitlements.

For step-by-step migration instructions, see the Rate Lock v1 to v2 Migration Guide.

{
   "status": "completed",
   "loanFormat": "application/vnd.plm-2.0.0+json",
   "loan": {
      ... // Additional loan data, sent as part of standard transaction loan update
   },
   "result": {
      "format": "application/vnd.productpricing-lock-2.0.0.json",
      "action": "LOCK",
      "details": {
         ... // Rate lock action details
      }
   },
   "partnerStatus": "partner status",
   "respondingParty": {
      "name": "PPE partner",
      "address": "P.O. BOX 509124, SUITE 300",
      "city": "SAN DIEGO",
      "state": "CA",
      "postalCode": "92150",
      "pointOfContact": {
         "fax": "8002376526",
         "phone": "8009864343",
         "email": "[email protected]"
      }
   },
   "referenceNumber": "000901"
}

The loan fields that are saved in the lock snapshot are listed on the Rate Lock page.

Structure of the details object

ObjectAdditional Information
$.result.details.pricingInformationOptional. Pricing history for the lock. When sent, historyXml is required and must not be empty.
$.result.details.additionalFieldsOptional. Array of additional Encompass fields to update, each with a fieldName and a value.
$.result.details.requestSideRequest side of the lock.
$.result.details.buySideBuy side of the lock, including concessions and profit margin adjustments.
$.result.details.sellSideSell side of the lock, including servicing, pool, and investor details.
$.result.details.comparisonSideComparison side of the lock, including the comparison investor.

At least one of requestSide, buySide, sellSide, or comparisonSide is required, and each side object that you send must contain at least one property.

The complete list of supported fields in the lock request action details object is defined in the JSON schema below. You can use online tools such as JSON Schema Validator to manually validate the contents of a details object.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "validationMessage": {
    "anyOfError": "Any one of requestSide, buySide, sellSide or comparisonSide is required.",
    "timePattern": "Time should be in the format HH:MM"
  },
  "additionalProperties": false,
  "definitions": {
    "stringType": {
      "type": "string",
      "description": "A generic string type"
    },
    "decimalType": {
      "type": "number",
      "description": "A decimal number type"
    },
    "integerType": {
      "type": "integer",
      "description": "A decimal number type"
    },
    "dateType": {
      "type": "string",
      "format": "date",
      "description": "A date in ISO 8601 format (YYYY-MM-DD)"
    },
    "timePattern": {
      "type": "string",
      "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$",
      "validationMessage": {
        "$ref": "#/validationMessage/timePattern"
      }
    },
    "adjustment": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "priceAdjustmentTypeIndex": {
          "$ref": "#/definitions/integerType",
          "description": "Index of the price adjustment type"
        },
        "description": {
          "$ref": "#/definitions/stringType",
          "description": "Description of the adjustment"
        },
        "rate": {
          "$ref": "#/definitions/decimalType",
          "description": "Rate of the adjustment"
        }
      }
    },
    "corporateAdjustment": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "concessionIndex": {
          "$ref": "#/definitions/integerType",
          "description": "Index of the corporate adjustment type"
        },
        "reason": {
          "$ref": "#/definitions/stringType",
          "description": "Reason of the adjustment"
        },
        "approvedBy": {
          "$ref": "#/definitions/stringType",
          "description": "Name of the person who approved the adjustment"
        },
        "approvalDate": {
          "$ref": "#/definitions/dateType",
          "description": "Date when the adjustment was approved"
        },
        "price": {
          "$ref": "#/definitions/decimalType",
          "description": "Price of the adjustment"
        }
      }
    },
    "investor": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "$ref": "#/definitions/stringType",
          "description": "Name of the investor"
        },
        "contact": {
          "$ref": "#/definitions/stringType",
          "description": "Contact information of the investor"
        },
        "phone": {
          "$ref": "#/definitions/stringType",
          "description": "Phone number of the investor"
        },
        "email": {
          "$ref": "#/definitions/stringType",
          "description": "Email address of the investor"
        },
        "address": {
          "$ref": "#/definitions/stringType",
          "description": "Address of the investor"
        },
        "city": {
          "$ref": "#/definitions/stringType",
          "description": "City of the investor"
        },
        "state": {
          "$ref": "#/definitions/stringType",
          "description": "State of the investor"
        },
        "postalCode": {
          "$ref": "#/definitions/stringType",
          "description": "Postal code of the investor"
        },
        "website": {
          "$ref": "#/definitions/stringType",
          "description": "Website of the investor"
        },
        "lockType": {
          "type": "string",
          "enum": [
            "Mandatory",
            "BestEfforts"
          ],
          "description": "Type of lock associated with the investor"
        },
        "programCode": {
          "$ref": "#/definitions/stringType",
          "description": "Program code associated with the investor"
        },
        "loanNumber": {
          "$ref": "#/definitions/stringType",
          "description": "Loan number associated with the investor"
        },
        "commitment": {
          "$ref": "#/definitions/stringType",
          "description": "Commitment details of the investor"
        },
        "mersNumber": {
          "$ref": "#/definitions/stringType",
          "description": "MERS number associated with the investor"
        },
        "lockedWithInvestorDate": {
          "$ref": "#/definitions/dateType",
          "description": "Date when locked with the investor"
        },
        "timeLockedWithInvestor": {
          "$ref": "#/definitions/stringType",
          "description": "Time when locked with the investor"
        },
        "deliveryDate": {
          "$ref": "#/definitions/dateType",
          "description": "Delivery date"
        },
        "targetDeliveryDate": {
          "$ref": "#/definitions/dateType",
          "description": "Target delivery date"
        }
      }
    },
    "comparisonSideInvestor": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "$ref": "#/definitions/stringType",
          "description": "Name of the investor"
        },
        "contact": {
          "$ref": "#/definitions/stringType",
          "description": "Contact information of the investor"
        },
        "phone": {
          "$ref": "#/definitions/stringType",
          "description": "Phone number of the investor"
        },
        "email": {
          "$ref": "#/definitions/stringType",
          "description": "Email address of the investor"
        },
        "address": {
          "$ref": "#/definitions/stringType",
          "description": "Address of the investor"
        },
        "city": {
          "$ref": "#/definitions/stringType",
          "description": "City of the investor"
        },
        "state": {
          "$ref": "#/definitions/stringType",
          "description": "State of the investor"
        },
        "postalCode": {
          "$ref": "#/definitions/stringType",
          "description": "Postal code of the investor"
        },
        "website": {
          "$ref": "#/definitions/stringType",
          "description": "Website of the investor"
        },
        "lockType": {
          "type": "string",
          "enum": [
            "Mandatory",
            "BestEfforts"
          ],
          "description": "Type of lock associated with the investor"
        },
        "programCode": {
          "$ref": "#/definitions/stringType",
          "description": "Program code associated with the investor"
        }
      }
    },
    "additionalFieldItem": {
      "type": "object",
      "properties": {
        "fieldName": {
          "type": "string",
          "description": "Identifier of the additional field in encompass"
        },
        "value": {
          "description": "value for the additional field"
        }
      },
      "additionalProperties": false
    }
  },
  "properties": {
    "pricingInformation": {
      "type": "object",
      "properties": {
        "historyXml": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "historyXml"
      ],
      "additionalProperties": false
    },
    "requestSide": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "rateSheetId": {
          "$ref": "#/definitions/stringType",
          "description": "Rate sheet ID for the request side"
        },
        "lockDate": {
          "$ref": "#/definitions/dateType",
          "description": "Lock date"
        },
        "numberOfDays": {
          "$ref": "#/definitions/integerType",
          "description": "Number of days for the lock"
        },
        "lockExpires": {
          "$ref": "#/definitions/dateType",
          "description": "Lock expiration date"
        },
        "rate": {
          "$ref": "#/definitions/decimalType",
          "description": "Rate for the request side"
        },
        "priceRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Price rate for the request side"
        },
        "comments": {
          "$ref": "#/definitions/stringType",
          "description": "Comments for the request side"
        },
        "marginRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Margin rate for the request side"
        },
        "currentRateSetDate": {
          "$ref": "#/definitions/dateType",
          "description": "Current rate set date"
        },
        "unDiscountedRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Undiscounted rate for the request side"
        },
        "startingAdjustmentRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Starting adjustment rate for the request side"
        },
        "startingAdjustmentPoint": {
          "$ref": "#/definitions/decimalType",
          "description": "Starting adjustment point for the request side"
        },
        "commitmentType": {
          "type": "string",
          "enum": [
            "Mandatory",
            "BestEfforts"
          ],
          "description": "commitment type"
        },
        "srpPaidOut": {
          "$ref": "#/definitions/decimalType",
          "description": "SRP paid out for the request side"
        },
        "programNotes": {
          "$ref": "#/definitions/stringType",
          "description": "Program notes for the request side"
        },
        "baseRateAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base rate adjustments for the request side"
        },
        "basePriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base price adjustments for the request side"
        },
        "baseMarginAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base margin adjustments for the request side"
        },
        "lockExtensionAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Lock extension adjustments for the request side"
        },
        "reLockFeeAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Re-lock fee adjustments for the request side"
        },
        "customPriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Custom price adjustments for the request side"
        },
        "onrpLockDate": {
          "$ref": "#/definitions/dateType",
          "description": "onrp lock date"
        },
        "onrpLockTime": {
          "type": "string",
          "$ref": "#/definitions/timePattern",
          "description": "onrp lock time"
        }
      }
    },
    "buySide": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "rateSheetId": {
          "$ref": "#/definitions/stringType",
          "description": "Rate sheet ID for the buy side"
        },
        "lockDate": {
          "$ref": "#/definitions/dateType",
          "description": "Lock date"
        },
        "numberOfDays": {
          "$ref": "#/definitions/integerType",
          "description": "Number of days for the lock"
        },
        "lockExpires": {
          "$ref": "#/definitions/dateType",
          "description": "Lock expiration date"
        },
        "rate": {
          "$ref": "#/definitions/decimalType",
          "description": "Rate for the buy side"
        },
        "priceRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Price rate for the buy side"
        },
        "comments": {
          "$ref": "#/definitions/stringType",
          "description": "Comments for the buy side"
        },
        "srpPaidOut": {
          "$ref": "#/definitions/decimalType",
          "description": "SRP paid out for the buy side"
        },
        "marginRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Margin rate for the buy side"
        },
        "currentRateSetDate": {
          "$ref": "#/definitions/dateType",
          "description": "Current rate set date"
        },
        "profitMarginAdjustedBuyPrice": {
          "$ref": "#/definitions/decimalType",
          "description": "Profit margin adjusted buy price"
        },
        "unDiscountedRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Undiscounted rate for the buy side"
        },
        "startingAdjustmentRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Starting adjustment rate for the buy side"
        },
        "startingAdjustmentPoint": {
          "$ref": "#/definitions/decimalType",
          "description": "Starting adjustment point for the buy side"
        },
        "commitmentType": {
          "type": "string",
          "enum": [
            "Mandatory",
            "BestEfforts"
          ],
          "description": "commitment type"
        },
        "deliveryType": {
          "type": "string",
          "enum": [
            "IndividualMandatory",
            "IndividualBestEfforts",
            "AOT",
            "Forwards",
            "DirectTrade",
            "Bulk",
            "BulkAOT",
            "CoIssue"
          ],
          "description": "Delivery type for the buy side"
        },
        "investor": {
          "type": "object",
          "properties": {
            "name": {
              "$ref": "#/definitions/stringType",
              "description": "Name of the investor"
            },
            "commitment": {
              "$ref": "#/definitions/stringType",
              "description": "Commitment details of the investor"
            }
          },
          "additionalProperties": false,
          "description": "Investor details for the buy side"
        },
        "corporateConcessions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/corporateAdjustment"
          },
          "description": "Corporate concessions for the buy side"
        },
        "branchConcessions": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/corporateAdjustment"
          },
          "description": "Branch concessions for the buy side"
        },
        "baseRateAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base rate adjustments for the buy side"
        },
        "basePriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base price adjustments for the buy side"
        },
        "baseMarginAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base margin adjustments for the buy side"
        },
        "profitMarginAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Profit margin adjustments for the buy side"
        },
        "lockExtensionAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Lock extension adjustments for the buy side"
        },
        "reLockFeeAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Re-lock fee adjustments for the buy side"
        },
        "customPriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Custom price adjustments for the buy side"
        }
      }
    },
    "sellSide": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "rateSheetId": {
          "$ref": "#/definitions/stringType",
          "description": "Rate sheet ID for the sell side"
        },
        "lockDate": {
          "$ref": "#/definitions/dateType",
          "description": "Lock date for the sell side"
        },
        "numberOfDays": {
          "$ref": "#/definitions/integerType",
          "description": "Number of days for the lock on the sell side"
        },
        "lockExpires": {
          "$ref": "#/definitions/dateType",
          "description": "Lock expiration date for the sell side"
        },
        "rate": {
          "$ref": "#/definitions/decimalType",
          "description": "Rate for the sell side"
        },
        "priceRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Price rate for the sell side"
        },
        "comments": {
          "$ref": "#/definitions/stringType",
          "description": "Comments for the sell side"
        },
        "srpPaidOut": {
          "$ref": "#/definitions/decimalType",
          "description": "SRP paid out for the sell side"
        },
        "marginRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Margin rate for the sell side"
        },
        "currentRateSetDate": {
          "$ref": "#/definitions/dateType",
          "description": "Current rate set date for the sell side"
        },
        "servicingType": {
          "type": "string",
          "enum": [
            "ServiceRetained",
            "ServiceReleased"
          ],
          "description": "Servicing type for the sell side"
        },
        "servicer": {
          "$ref": "#/definitions/stringType",
          "description": "Servicer for the sell side"
        },
        "servicingFee": {
          "$ref": "#/definitions/decimalType",
          "description": "Servicing fee for the sell side"
        },
        "guaranteeFee": {
          "$ref": "#/definitions/decimalType",
          "description": "Guarantee fee for the sell side"
        },
        "poolNumber": {
          "$ref": "#/definitions/stringType",
          "description": "Pool number for the sell side"
        },
        "commitmentDate": {
          "$ref": "#/definitions/dateType",
          "description": "Commitment date for the sell side"
        },
        "poolId": {
          "$ref": "#/definitions/stringType",
          "description": "Pool ID for the sell side"
        },
        "commitmentContractNumber": {
          "$ref": "#/definitions/stringType",
          "description": "Commitment contract number for the sell side"
        },
        "productName": {
          "$ref": "#/definitions/stringType",
          "description": "Product name for the sell side"
        },
        "msrValue": {
          "$ref": "#/definitions/decimalType",
          "description": "MSR value for the sell side"
        },
        "guarantyBaseFee": {
          "$ref": "#/definitions/decimalType",
          "description": "Guaranty base fee for the sell side"
        },
        "investor": {
          "$ref": "#/definitions/investor",
          "description": "Investor details for the sell side"
        },
        "baseRateAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base rate adjustments for the sell side"
        },
        "basePriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base price adjustments for the sell side"
        },
        "baseMarginAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base margin adjustments for the sell side"
        },
        "lockExtensionAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Lock extension adjustments for the sell side"
        },
        "reLockFeeAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Re-lock fee adjustments for the sell side"
        },
        "customPriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Custom price adjustments for the sell side"
        }
      }
    },
    "comparisonSide": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": false,
      "properties": {
        "rateSheetId": {
          "$ref": "#/definitions/stringType",
          "description": "Rate sheet ID for the comparison side"
        },
        "currentRateSetDate": {
          "$ref": "#/definitions/dateType",
          "description": "Current rate set date for the comparison side"
        },
        "lockDate": {
          "$ref": "#/definitions/dateType",
          "description": "Lock date for the comparison side"
        },
        "numberOfDays": {
          "$ref": "#/definitions/integerType",
          "description": "Number of days for the lock on the comparison side"
        },
        "lockExpires": {
          "$ref": "#/definitions/dateType",
          "description": "Lock expiration date for the comparison side"
        },
        "rate": {
          "$ref": "#/definitions/decimalType",
          "description": "Rate for the comparison side"
        },
        "priceRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Price rate for the comparison side"
        },
        "marginRate": {
          "$ref": "#/definitions/decimalType",
          "description": "Margin rate for the comparison side"
        },
        "srpPaidOut": {
          "$ref": "#/definitions/decimalType",
          "description": "SRP paid out for the comparison side"
        },
        "servicingType": {
          "type": "string",
          "enum": [
            "ServiceRetained",
            "ServiceReleased"
          ],
          "description": "Servicing type for the comparison side"
        },
        "comments": {
          "$ref": "#/definitions/stringType",
          "description": "Comments for the comparison side"
        },
        "investor": {
          "$ref": "#/definitions/comparisonSideInvestor",
          "description": "Investor details for the comparison side"
        },
        "baseRateAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base rate adjustments for the comparison side"
        },
        "basePriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base price adjustments for the comparison side"
        },
        "baseMarginAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Base margin adjustments for the comparison side"
        },
        "lockExtensionAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Lock extension adjustments for the comparison side"
        },
        "reLockFeeAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Re-lock fee adjustments for the comparison side"
        },
        "customPriceAdjustments": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/adjustment"
          },
          "description": "Custom price adjustments for the comparison side"
        }
      }
    },
    "additionalFields": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/additionalFieldItem"
      },
      "description": "Additional fields in the rate lock."
    }
  },
  "anyOf": [
    {
      "required": [
        "requestSide"
      ],
      "validationMessage": {
        "$ref": "#/validationMessage/anyOfError"
      }
    },
    {
      "required": [
        "buySide"
      ],
      "validationMessage": {
        "$ref": "#/validationMessage/anyOfError"
      }
    },
    {
      "required": [
        "sellSide"
      ],
      "validationMessage": {
        "$ref": "#/validationMessage/anyOfError"
      }
    },
    {
      "required": [
        "comparisonSide"
      ],
      "validationMessage": {
        "$ref": "#/validationMessage/anyOfError"
      }
    }
  ]
}

Below is a sample rate lock request payload with most of the fields supported in version 2.0.0:

{
  "status": "completed",
  "loanFormat": "application/vnd.plm-2.0.0+json",
  "loan": {
    "property": {
      "addressLineText": "Test address",
      "loanPurposeType": "ConstructionOnly",
      "AppraisedValueAmount": 50000,
      "propertyUsageType": "PrimaryResidence",
      "condotelIndicator": true,
      "nonwarrantableProjectIndicator": true,
      "city": "Pleasanton",
      "state": "California",
      "postalCode": "94588",
      "county": "Alameda",
      "financedNumberOfUnits": 10,
      "streetAddress": "4420 Rosewood Drive",
      "unitType": "Apartment",
      "unitNumber": 7
    },
    "loanProductData": {
      "loanDocumentationType": "FullDocumentation",
      "lienPriorityType": "FirstLien",
      "fnmProductPlanIdentifier": "N",
      "borrowerEstimatedClosingDate": "06/01/2020",
      "balloonLoanMaturityTermMonthsCount": 18,
      "gsePropertyType": "Attached"
    },
    "gfe": {
      "fundingAmount": 41000
    },
    "freddieMac": {
      "helocActualBalance": "5000"
    },
    "regulationZ": {
      "lenderPaidMortgageInsuranceIndicator": true
    },
    "hudLoanData": {
      "loanFor203KIndicator": true,
      "totalForLesserOfSumAsIs": 3
    },
    "propertyUsageType": "PrimaryResidence",
    "creditScoreToUse": "750",
    "mortgageType": "Conventional",
    "loanAmortizationType": "Fixed Rate",
    "otherAmortizationTypeDescription": "Desc",
    "noClosingCostOption": true,
    "loanAmortizationTermMonths": 180,
    "baseLoanAmount": 450000,
    "borrowerRequestedLoanAmount": 460000,
    "firstSubordinateLienAmount": 450000,
    "secondSubordinateAmount": 44334433,
    "propertyAppraisedValueAmount": 650000,
    "purchasePriceAmount": 600000,
    "firstTimeHomebuyersIndicator": true,
    "otherSubordinateAmount": 1200,
    "twelveMonthMortgageRentalHistoryIndicator": true,
    "loanProgramName": "30 Year Fixed",
    "mipPaidInCashAmount": 3000
  },
  "result": {
    "format": "application/vnd.productpricing-lock-2.0.0.json",
    "action": "LOCK",
    "details": {
      "pricingInformation": {
        "historyXml": "<PricingHistory><Entry date=\"2026-10-05\" rateSheetId=\"RS9110\" /></PricingHistory>"
      },
      "requestSide": {
        "rateSheetId": "RS9110",
        "lockDate": "2026-10-05",
        "numberOfDays": 30,
        "lockExpires": "2026-11-04",
        "rate": 6.375,
        "priceRate": 100.125,
        "marginRate": 0,
        "currentRateSetDate": "2026-10-05",
        "unDiscountedRate": 6.875,
        "startingAdjustmentRate": 6.5,
        "startingAdjustmentPoint": 0.5,
        "commitmentType": "BestEfforts",
        "srpPaidOut": 1.5,
        "programNotes": "30 year fixed conforming program",
        "comments": "Lock requested at borrower request",
        "baseRateAdjustments": [
          {
            "priceAdjustmentTypeIndex": 2,
            "description": "60 Day Lock Period",
            "rate": 0.125
          }
        ],
        "basePriceAdjustments": [
          {
            "priceAdjustmentTypeIndex": 0,
            "description": "No FICO",
            "rate": -0.25
          }
        ],
        "lockExtensionAdjustments": [
          {
            "priceAdjustmentTypeIndex": 0,
            "description": "Lock extension, 15 days",
            "rate": 0.125
          }
        ],
        "reLockFeeAdjustments": [
          {
            "priceAdjustmentTypeIndex": 0,
            "description": "Relock fee",
            "rate": 0.25
          }
        ],
        "customPriceAdjustments": [
          {
            "priceAdjustmentTypeIndex": 0,
            "description": "Custom price adjustment",
            "rate": 0.05
          }
        ],
        "onrpLockDate": "2026-10-05",
        "onrpLockTime": "14:30"
      },
      "buySide": {
        "rateSheetId": "RS9110",
        "lockDate": "2026-10-05",
        "numberOfDays": 30,
        "lockExpires": "2026-11-04",
        "rate": 6.375,
        "priceRate": 100.125,
        "marginRate": 0,
        "srpPaidOut": 1.5,
        "currentRateSetDate": "2026-10-05",
        "profitMarginAdjustedBuyPrice": 100.375,
        "unDiscountedRate": 6.875,
        "startingAdjustmentRate": 6.5,
        "startingAdjustmentPoint": 0.5,
        "commitmentType": "BestEfforts",
        "deliveryType": "IndividualBestEfforts",
        "investor": {
          "name": "ABC Mortgage Investors",
          "commitment": "CMT-100045"
        },
        "comments": "Buy side confirmed",
        "corporateConcessions": [
          {
            "concessionIndex": 1,
            "reason": "Competitive match",
            "approvedBy": "John Doe",
            "approvalDate": "2026-10-05",
            "price": 0.125
          }
        ],
        "branchConcessions": [
          {
            "concessionIndex": 1,
            "reason": "Branch pricing exception",
            "approvedBy": "Jane Doe",
            "approvalDate": "2026-10-05",
            "price": 0.05
          }
        ],
        "baseRateAdjustments": [
          {
            "priceAdjustmentTypeIndex": 2,
            "description": "60 Day Lock Period",
            "rate": 0.125
          }
        ],
        "basePriceAdjustments": [
          {
            "priceAdjustmentTypeIndex": 0,
            "description": "No FICO",
            "rate": -0.25
          }
        ],
        "profitMarginAdjustments": [
          {
            "priceAdjustmentTypeIndex": 3,
            "description": "LO Comp",
            "rate": 0.99
          }
        ]
      },
      "sellSide": {
        "rateSheetId": "RS9110",
        "lockDate": "2026-10-05",
        "numberOfDays": 30,
        "lockExpires": "2026-11-04",
        "rate": 6.375,
        "priceRate": 101.25,
        "marginRate": 0,
        "srpPaidOut": 1.25,
        "currentRateSetDate": "2026-10-05",
        "servicingType": "ServiceReleased",
        "servicer": "ABC Servicing",
        "servicingFee": 0.25,
        "guaranteeFee": 0.45,
        "poolNumber": "POOL-1001",
        "commitmentDate": "2026-10-05",
        "poolId": "P1001",
        "commitmentContractNumber": "CC-342432",
        "productName": "30 Year Fixed",
        "msrValue": 1.1,
        "guarantyBaseFee": 0.45,
        "comments": "Sold to investor under best efforts commitment",
        "investor": {
          "name": "ABC Mortgage Investors",
          "contact": "Pat Lee",
          "phone": "8005550100",
          "email": "[email protected]",
          "address": "100 Main Street",
          "city": "San Diego",
          "state": "CA",
          "postalCode": "92101",
          "website": "https://www.example.com",
          "lockType": "BestEfforts",
          "programCode": "CF30",
          "loanNumber": "INV-778899",
          "commitment": "CMT-100045",
          "mersNumber": "100000000000000001",
          "lockedWithInvestorDate": "2026-10-05",
          "timeLockedWithInvestor": "14:30",
          "deliveryDate": "2026-11-02",
          "targetDeliveryDate": "2026-10-30"
        },
        "basePriceAdjustments": [
          {
            "priceAdjustmentTypeIndex": 0,
            "description": "Loan Level Price Adjustment",
            "rate": -0.375
          }
        ]
      },
      "comparisonSide": {
        "rateSheetId": "RS9110",
        "currentRateSetDate": "2026-10-05",
        "lockDate": "2026-10-05",
        "numberOfDays": 30,
        "lockExpires": "2026-11-04",
        "rate": 6.5,
        "priceRate": 100.875,
        "marginRate": 0,
        "srpPaidOut": 1.0,
        "servicingType": "ServiceReleased",
        "comments": "Best alternate investor pricing",
        "investor": {
          "name": "XYZ Capital Markets",
          "contact": "Pat Lee",
          "phone": "8005550100",
          "email": "[email protected]",
          "address": "100 Main Street",
          "city": "San Diego",
          "state": "CA",
          "postalCode": "92101",
          "website": "https://www.example.com",
          "lockType": "BestEfforts",
          "programCode": "CF30"
        },
        "basePriceAdjustments": [
          {
            "priceAdjustmentTypeIndex": 0,
            "description": "Loan Level Price Adjustment",
            "rate": -0.375
          }
        ]
      },
      "additionalFields": [
        {
          "fieldName": "CX.PPE.PRICINGTIER",
          "value": "Gold"
        }
      ]
    }
  },
  "partnerStatus": "partner status",
  "respondingParty": {
    "name": "PPE partner",
    "address": "P.O. BOX 509124, SUITE 300",
    "city": "SAN DIEGO",
    "state": "CA",
    "postalCode": "92150",
    "pointOfContact": {
      "fax": "8002376526",
      "phone": "8009864343",
      "email": "[email protected]"
    }
  },
  "referenceNumber": "000901"
}

Did this page help you?