Edit Escrow Bucket Settings

This request allows you to edit a loan's Escrow Buckets.


There is a vast amount of configuration options available for escrow. Here is what you need to know about this request:

  • The EscrowSubsetOptions object is nested within the Loans entity, and it holds the configuration options for Escrow Buckets.
  • Users can configure up to 25 escrow buckets within their accounts.

For an example of how configuring escrow buckets works within the UI, take a look at our Update Escrow Account Settings article.


For information on escrow database tables, see the following articles:

     "EscrowSubsetOptions": {
          "results": [
                    "entityType": "Entity.Loan",
                    "title": "API Demo Bucket",
                    "payoffOption": "loan.escrowpayoff.standard",
                    "paymentApplication": "loan.escrowpmtapp.standard",
                    "aprInclude": 1,
                    "scheduleInclude": false,
                    "disclosureLnAmtAdd": "false",
                    "availability": "loan.escrowAvailability.both",
                    "interestBearing": false,
                    "escrowAnalysisEnabled": 0,
                    "cushion": 1,
                    "cushionFixedAmount": 100,
                    "cushionPercentage": 0,
                    "escrowComputationYearStartDate": "01/01/2021",
                    "nextEscrowAnalysisDate": "01/01/2022",
                    "deficiencyDelimitingDPD": 30,
                    "deficiencyDaysToPay": 30,
                    "deficiencyDelimitingAmount": 1,
                    "deficiencyDelimitingDollar": 0,
                    "deficiencyDelimitingPercentage": 0,
                    "deficiencyCatchupPaymentNumber": 2,
                    "deficiencyActionA": 1,
                    "deficiencyActionB": 0,
                    "deficiencyActionC": 0,
                    "shortageDaysToPay": 30,
                    "shortageCatchupPaymentNumber": 2,
                    "shortageDelimitingAmount": 1,
                    "shortageDelimitingDollar": 0,
                    "shortageDelimitingPercentage": 0,
                    "shortageActionA": 1,
                    "shortageActionB": 0,
                    "surplusAllowedSurplus": 50,
                    "surplusDaysToRefund": 30,
                    "surplusActionA": 1,
                    "surplusActionB": 0,
                    "surplusActionC": 1,
                    "__update": true,
                    "__id": 4


Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—expand the object by clicking the "+" symbol and hit Try It to send the request.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.

Click Try It! to start a request and see the response here!