Balloon Specified Final - Response

The specified final balloon loan response is almost identical to the specified regular balloon loan response, with the following differences:

1. The root element is <outBALLOON_SPECIFY_FINAL> instead of <outBALLOON_SPECIFY_REGULAR>.

Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.

🟥 <outBALLOON_SPECIFY_FINAL>

This element is the root element of the response, and contains all of the relevant outputs.

Attributes: 🔹CountryName

🔹 CountryName

If a valid Country code was specified as an attribute of the input module element, the full name of the country associated with the specified Country code will be reported in this attribute.

🟥 <Results>

This element contains child elements which describe the success or failure of the calculation, any warning or error messages, and the most important numerical results for the query.

<Results>
  <Description>Successful Calculation</Description>
  <Payment>523.06</Payment>
  <Final>5000.00</Final>
</Results>

Attributes: None

🟥 <Results>→<Description>

If the calculation was completed successfully, then this element will contain the value Successful Calculation. Otherwise, this element will contain a description of the problem encountered during the attempted computation.

Attributes: None

🟦 <Results>→<XMLDetail>[]

The <XMLDetail> elements are messages passed back to the calling application which detail the status of the XML request. If the SCEX issues any warnings regarding unrecognized elements or attributes, then each warning message will be displayed in an <XMLDetail> element.

Attributes: None

🟥 <Results>→<Payment>

The computed regular payment (<RegPmt>) amount which amortizes the loan, along with the specified final payment (<Final>).

Attributes: None

🟥 <Results>→<Final>

The specified final (or balloon) payment amount which amortizes the loan given the requested regular payment.

Attributes: None

🟥 <FedBox>

Some of the most important compliance related outputs are organized into the <FedBox> disclosures.

<FedBox>
  <AmtFin>10000.00</AmtFin>
  <FinChg>753.66</FinChg>
  <TotPmts>10753.66</TotPmts>
  <RegZAPR Type="Actuarial">10.030</RegZAPR>
</FedBox>

Attributes: None

🟥 <FedBox>→<AmtFin>

The Regulation Z Amount Financed, which is defined as the amount of credit provided to you or on your behalf.

Attributes: None

🟥 <FedBox>→<FinChg>

This element contains the Regulation Z Finance Charge, described as the dollar amount the credit extension will cost you.

Attributes: None

🟥 <FedBox>→<TotPmts>

The amount which the borrower will have paid when the borrower has made all scheduled payments.

Attributes: None

🟦 <FedBox>→<TotalSalePrice>

The sum of the total of payments plus the total down payment. Please note that if no <TotalDown> element was specified in the request, then this element will not be present.

Attributes: None

🟥 <FedBox>→<RegZAPR>

The Regulation Z APR, which is the cost of the extension of credit expressed as a yearly rate. The Reg. Z APR element has a few attributes, described below:

Attributes: 🔹Max, 🔹MaxExceeded, 🔸Type

🔹 Max

This attribute specifies the maximum APR as configured in the account's setup files. If no maximum APR has been specified, then this attribute will not be present. The value of this attribute should be displayed as a percentage. As an example, for Max="36.000", you would disclose a maximum APR of 36.000%.

🔹 MaxExceeded

If a maximum APR is configured in the account's setup files, then the value of this attribute indicates whether or not the current loan exceeds the maximum allowed APR. As an example, if the maximum APR has been set to 36% and the APR for the returned loan was 37.125%, the <RegZAPR> element would be:

<RegZAPR Type="Actuarial" Max="36.000" MaxExceeded="true">37.125</RegZAPR>

🔸 Type

This attribute specifies the method used to compute the reported APR: Actuarial or US Rule The method used is dictated by the setup files for the given account, but may be overridden in the XML input query.

• Actuarial - Governed by Appendix J to Regulation Z. Default US APR.
• USRule - Used by large banks to mirror loan amortization.
• EU_APR - Default European Union APR.
• Canadian_APR - Default APR for Canada.
• XIRR - Extended Internal Rate of Return (same as excel function).
• XIRR360 - XIRR using a 360 divisor rather than a 365 divisor.
• YieldIRR - Canadian mortgages may compute periodic interest using a fractional power of a periodic yield.
• Open_End - Simply returns the interest rate.

🟦 <FedBox>—><MAPR>

If the military APR has been requested, then this element will be included in the output. The value of the element is the military APR, and the element has a few attributes, described below:

Attributes: 🔸Advance, 🔹Max, 🔹MaxExceeded

🔸 Advance

This attribute is the equivalent of the Amount Financed for the Military APR. Specifically, it is the principal balance less any MAPR fees, debt protection, etc.

🔹 Max

This attribute specifies the maximum Military APR as specified in the input XML (see MAPR_Max). If not specified, a default value of 36% is assumed. The value of this attribute should be displayed as a percentage. As an example, for Max="36.0", you would disclose a maximum Military APR of 36.0%.

🔹 MaxExceeded

The value of this attribute indicates whether or not the current loan exceeds the maximum allowed Military APR. As an example, if the maximum APR has been set to 36% and the Military APR for the returned loan was 37.125%, the <MAPR> element would be:

<MAPR Advance="1350.00" Max="36.000" MaxExceeded="true">37.125</MAPR>

🟦 <TILARESPA2015>

This element contains child elements which are of interest to fulfilling the 2015 TILA RESPA rule. It will only be present if the <TILARESPA2015> element is present in the request.

Sample TILARESPA2015 output:

<TILARESPA2015>
  <TotalLoanCosts>0</TotalLoanCosts>
  <CD_TotPmts>27311.07</CD_TotPmts>
  <In5Years PaidTotal="27311" PaidPrincipal="25000"/>
  <TIP>9.244</TIP>
  <MaxPnIPmt Date="2012-11-01">1636.65</MaxPnIPmt>
  <MinRate Idx="1">5.651</MinRate>
  <MaxRate Idx="1">5.651</MaxRate>
  <ProjectedPayments NumCols="3">
      <PPCol Num="1" Title="Year 1">
        <Years Start="1" End="1"/>
        <PnIPmt Min="636.65" Max="1636.65" IntOnly="none" Balloon="false"/>
        <MIPmt>0.00</MIPmt>
        <TotalPmt Min="636.65" Max="1636.65"/>
      </PPCol>
      <PPCol Num="2" Title="Year 2">
        <Years Start="2" End="2"/>
        <PnIPmt Min="636.65" Max="1636.65" IntOnly="none" Balloon="false"/>
        <MIPmt>0.00</MIPmt>
        <TotalPmt Min="636.65" Max="1636.65"/>
      </PPCol>
      <PPCol Num="3" Title="Year 3">
        <Years Start="3" End="3"/>
        <PnIPmt Min="636.65" Max="1636.65" IntOnly="none" Balloon="false"/>
        <MIPmt>0.00</MIPmt>
        <TotalPmt Min="636.65" Max="1636.65"/>
      </PPCol>
  </ProjectedPayments>
</TILARESPA2015>

Attributes: None

🟦 <TILARESPA2015>→<LoanCost>[]

For every <Fee> element present in the input which has its IsLoanCost attribute set to true (and hence, is a borrower paid loan cost) and whose amount is greater than zero (except odd days interest fee types, as explained in the previous documentation of the <Fee> input element), there will be a corresponding <LoanCost> element. The value of this element will be the numerical value of the fee, rounded to the nearest dollar.

Attributes: 🔹In5Years, 🔹Name

🔹 In5Years

If the entire amount of the fee is different from the amount collected over the first five years (for example, a service charge), then this attribute will be present and disclose the portion of this loan cost that is accrued during the first five years.

🔹 Name

This attribute will hold the same value as the attribute of the same name for the <Fee> element. It is recommended that each fee have a unique Name for identification purposes.

🟥 <TILARESPA2015>→<TotalLoanCosts>

This element holds the sum of all borrower paid loan costs. Since all <LoanCost> element values are rounded dollar amounts, the value of this element will also be a rounded dollar amount.

Attributes: None

🟥 <TILARESPA2015>→<CD_TotPmts>

This element holds the sum of the total of payments, all borrower paid loan costs, and any odd days interest that is prepaid at loan closing. This value will be the numerical value of the sum.

Attributes: None

🟥 <TILARESPA2015>→<In5Years>

This element is empty, with all important values required for the new "In 5 Years" section returned in the following two attributes of this element.

Attributes: 🔸PaidPrincipal, 🔸PaidTotal

🔸 PaidPrincipal

This attribute holds "the principal scheduled to be paid through the end of the 60th month after the due date of the first periodic payment". Note that this value is rounded to the nearest whole dollar.

🔸 PaidTotal

This attribute holds the sum of all "principal, interest, mortgage insurance, and borrower paid loan costs scheduled to be paid through the end of the 60th month after the due date of the first periodic payment". Note that this value is rounded to the nearest whole dollar.

🟥 <TILARESPA2015>→<TIP>

The value of this element holds the total interest percentage, rounded to three or fewer decimal places, as required.

Attributes: None

🟥 <TILARESPA2015>→<MaxPnIPmt>

The value of this element holds the maximum scheduled principal and interest payment during the term of the loan.

Attributes: 🔸Date

🔸 Date

This attribute contains the date on which the maximum scheduled principal and interest payment is made. If the maximum scheduled payment occurs more than once, then the date returned is that of the first instance. All dates are in the form of YYYY-MM-DD, and must be 10 characters long.

🟥 <TILARESPA2015>→<MinRate>

The value of this element holds the minimum possible interest rate applied during the term of the loan.

Attributes: 🔸Idx

🔸 Idx

This attribute contains the payment number for which the minimum rate is first applicable.

🟥 <TILARESPA2015>→<MaxRate>

The value of this element holds the maximum possible interest rate applied during the term of the loan.

Attributes: 🔸Idx

🔸 Idx

This attribute contains the payment number for which the maximum rate is first applicable.

🟥 <TILARESPA2015>→<ProjectedPayments>

This element contains child elements which are of interest to filling the Projected Payments table. It will only be present if the <TILARESPA2015> element is present in the XML request for a supported loan type.

Attributes: 🔸NumCols

🔸 NumCols

This attribute will hold the number of columns which must be present in the Projected Payments table. It will be a numeric value from 1 to 4.

🟥 <ProjectedPayments>→<PPCol>[]

For every column required in the Projected Payments table, there will be an associated <PPCol> element. This element is a parent to child elements which contain data associated with a single column of the table.

Attributes: 🔸Num, 🔸Title

🔸 Num

This attribute will hold the number of the column to which the following data applies.

🔸 Title

The value of this attribute is the title for the column. Most of the time, it will be in the form of Years X - Y, or Year X, or Final Payment in the case of a final balloon payment.

🟥 <ProjectedPayments>→<PPCol>→<Years>

The attributes of this element hold the beginning and ending year numbers for which this column data applies. The element itself is empty.

Attributes: 🔸End, 🔸Start

🔸 End

The ending year associated with this column's data.

🔸 Start

The beginning year associated with this column's data.

🟥 <ProjectedPayments>→<PPCol>→<PnIPmt>

This empty element has several attributes which describe the principal and interest payments associated with this column.

Attributes: 🔸Balloon, 🔸IntOnly, 🔸Max, 🔸Min

🔸 Balloon

If any of the payments associated with this column are balloon payments (e.g. isolated payments that are more than twice the value of a regular periodic payment), then the value of this attribute will be true.

🔸 IntOnly

• none - No payments associated with the column are Interest Only
• some - Some, but not all, of the payments associated with the column are Interest Only.
• all - All of the payments associated with the column are Interest Only.

Note that for the purposes of this attribute, a scheduled payment is considered an interest only payment if the payment amount pays off all interest due at the time of the payment, with no reduction in the principal balance.

🔸 Max

This attribute holds the maximum principal and interest payment for this column. If this value is not the same as the value of the Min attribute, then a range of rounded payments must be displayed. If the values are the same, then only a single value needs to be disclosed.

🔸 Min

This attribute holds the minimum principal and interest payment for this column.

🟥 <ProjectedPayments>→<PPCol>→<MIPmt>

The value of this element holds the mortgage insurance premium associated with this column, rounded to the nearest dollar. If no mortgage insurance is present or coverage has been dropped, a value of zero will be present.

Attributes: None

🟥 <ProjectedPayments>→<PPCol>→<TotalPmt>

This empty element has two attributes which describe the estimated total payment or range of payments associated with this column. Note that this value does not include any estimated escrow, as the SCEX does not support escrow calculations. The calling application will need to increase these values by the estimated escrow amounts if any are present.

Attributes: 🔸Max, 🔸Min

🔸 Max

This attribute holds the maximum estimated total payment for this column. If this value is not the same as the value of the Min attribute, then a range of rounded payments must be displayed. If the values are the same, then only a single value needs to be disclosed.

🔸 Min

This attribute holds the minimum estimated total payment for this column.

🟥 <Moneys>

This element groups together those other major cash amounts not disclosed under the <FedBox> element, such as the principal balance, interest change, fee amounts and protection premiums.

   <Moneys>
      <Principal>10120.00</Principal>
      <Interest>1635.80</Interest>
      <OddDaysPrepaid OddDayCount="15" DailyCost="2.77">41.55</OddDaysPrepaid>
      <FinFees>120.00</FinFees>
      <FinChgFees>91.55</FinChgFees>
      <PocketFees>65.00</PocketFees>
      <MAPRFees>201.55</MAPRFees>
      <Protection Category="None" PerPmt="0.00" PerDay="0.00">0.00</Protection>
      <Fee Name="FinFee">60.00</Fee>
      <Fee Name="Prepaid Fee">50.00</Fee>
   </Moneys>

Attributes: None

🟥 <Moneys>→<Principal>

The principal balance is the amount on which interest is accrued. The principal balance consists of the amount requested by the borrower, any fees which are financed, as well as financed protection premiums.

Attributes: None

🟥 <Moneys>→<Interest>

This element contains the total interest accrued during the term of the loan, assuming the borrower will make all scheduled payments.

Attributes: None

🟦 <Moneys>→<ConstructInterest>

If the requested loan is a construction loan with a permanent loan attached and the account specified is set up to compute construction loans via the "Simple" method, then this element will contain the construction interest for the requested loan.

Note that if a permanent loan is attached to a construction loan and the account is set up to use the "LaserPro" method, then the construction and permanent loans are combined into a single loan, with the construction (and permanent) loan's interest being reflected in the <Interest> element, and both loans reflected in a single, combined amortization schedule.

If the requested loan was not a construction loan, or if construction loans have not been set up for the given account, then this element will not appear in the results.

Attributes: None

🟦 <Moneys>→<OddDaysPrepaid>

This element, if present, holds the total odd days prepaid finance charge. If no odd days prepaid fee was requested, then this element will not be present in the output.

Attributes: 🔹AddToPmt, 🔹DailyCost, 🔸OddDayCount, 🔹OddMonths

🔹 AddToPmt

If the odd days interest has been added to the first payment, this attribute will be present in the output with a value of true. If the odd days interest has been treated as a prepaid finance charge, then this attribute will not be present and a default value of false should be assumed.

🔹 DailyCost

If the odd days prepaid fee is computed using a rounded daily cost, then the value of this attribute will hold that value. If the odd days prepaid is not computed using a rounded daily cost, then this attribute will not be present.

🔸 OddDayCount

This attribute holds the number of odd days computed by the SCE for the requested loan.

🔹 OddMonths

This attribute holds the number of odd months computed by the SCE for the requested loan when using odd days accrual method 250.

🟦 <Moneys>→<MinInterestPmt>

The <MinInterestPmt> element will only appear if the Metavante attribute has been set to true, and even then only under certain loan conditions. The element itself contains no data, as all required data is found in the following two attributes:

Attributes: 🔸Index, 🔸Pmt

🔸 Index

The Index attribute specifies the payment number in the payment stream at which the minimum interest payment is achieved.

🔸 Pmt

The interest payment amount for the given Index.

🟦 <Moneys>→<MaxInterestPmt>

The <MaxInterestPmt> element will only appear if the Metavante attribute has been set to true, and even then only under certain loan conditions. The element itself contains no data, as all required data is found in the following two attributes:

Attributes: 🔸Index, 🔸Pmt

🔸 Index

The Index attribute specifies the payment number in the payment stream at which the maximum interest payment is achieved.

🔸 Pmt

The interest payment amount for the given Index.

🟦 <Moneys>→<FinFees>

This element contains the sum of all financed fees requested for the loan. If no financed fees were requested, then this element will not show up in the response.

Attributes: None

🟦 <Moneys>→<FinChgFees>

This element contains the sum of all APR affecting fees (those fees which are added to the <FinChg>) requested for the loan. If no APR affecting fees were requested, then this element will not show up in the response.

Attributes: None

🟦 <Moneys>→<PocketFees>

This element holds the sum of all fees which are neither financed, nor added to the finance charge. In essence, they are paid out of the borrower’s pocket. If no out-of-pocket fees were requested, then this element will not show up in the response.

Attributes: None

🟦 <Moneys>→<MAPRFees>

This element holds the sum of all fees which are Military APR fees (including protection products), and will only appear if the Military APR has been requested.

Attributes: None

🟦 <Moneys>→<Protection>

Contains the total cost of all protection plans included with the computed loan. For the individual plan costs, see the <ProtectionInfo> elements described below. The attributes of this element are as follows:

Attributes: 🔸Category, 🔹IsDp, 🔹Mandatory, 🔸PerDay, 🔸PerPmt

🔸 Category

This attribute specifies the category under which the computed loan protection falls. The possible values for this attribute are:

• None - No protection catetory has been identified.
• SP - Single Premium protection financed at loan closing.
• MOB - Monthly outstanding balance (paid on Payments).
• TrueMOB - Premiums paid monthly on a date specified in the setup files.
• PaidSP - Single premium protection paid at closing.
• ConstantMOB - CMOB is a product paid with payments and a constant amount.
• AddToPmtMOB - MOB insurance added to a constant P&I payment, resulting in variable payments.

🔹 IsDp

This attribute indicates if the specified account’s protection is set up as debt protection. If this attribute is not present, then the default value of false should be used (which indicates that the account’s protection is set up as insurance instead).

🔹 Mandatory

This attribute should only appear in the response if the value of the attribute is true. If this attribute does not appear in the output, then the value of this attribute should default to false. If the value of the Mandatory attribute is true, then the total premium/fee amount for all insurance/debt protection products has been treated as a part of the Regulation Z Finance Charge, and hence will affect the Reg. Z APR.

🔸 PerDay

Contains the cost of all loan protection products expressed as dollars per day.

🔸 PerPmt

Contains the cost of all loan protection products expressed as dollars per payment.

🟦 <Moneys>→<MinIntChgAdj>

If a minimum interest charge is configured in the account’s setup files and the final payment was adjusted to meet this minimum interest charge, then this element will be returned in the response and will contain the value of the minimum finance charge adjustment.

Attributes: None

🟦 <Moneys>→<MinFinChgAdj>

If a minimum finance charge is configured in the account’s setup files and the final payment was adjusted to meet this minimum finance charge, then this element will be returned in the response and will contain the value of the minimum finance charge adjustment.

Attributes: None

🟦 <Moneys>→<Fee>[]

For each non-zero fee requested in the loan calculation, there will be a <Fee> element containing the computed fee amount.

Attributes: 🔹Name

🔹 Name

Contains the value of the Name attribute of the corresponding <Fee> element from the request. If no such attribute is present in the <Fee> element, then none will be present in the response element.

🟦 <Moneys>→<ServiceCharge>[]

For each non-zero service charge requested in the loan calculation, there will be a <ServiceCharge> element containing the total service charge amount.

Attributes: 🔹Name

🔹 Name

Contains the value of the Name attribute of the corresponding <ServiceCharge> element from the request. If no such attribute is present in the request element, then none will be present in the response element.

🟦 <Moneys>→<PMI_Fee>

If PMI has been requested on the loan, and if a number of up front payments have been specified, then this element will hold the total PMI fee for all upfront payments.

Attributes: None

🟥 <Accrual>

This element groups together interest accrual information, such as the accrual method used, days to the first payment, and the loan’s maturity date.

<Accrual>
  <Method>Actual/365 US Rule</Method>
  <Days1Pmt DayCount="Actual">74</Days1Pmt>
  <Maturity>2015-07-01</Maturity>
</Accrual>

Attributes: None

🟥 <Accrual>→<Method>

The <Method> element contains a textual description of the interest accrual method used to compute the loan (e.g. "Unit Period 365 Simple").

Attributes: None

🟥 <Accrual>→<Days1Pmt>

This element contains the number of days to the first payment, computed by one of two methods as specified in this element’s sole attribute.

Attributes: 🔸DayCount

🔸 DayCount

• Actual - The actual number of days between these two dates are used. 31 would be the day count for the 2024-01-01 to 2024-02-01.
• True360 - All months have 30 days. 30 would be the day count for 2024-01-01 to 2024-02-01.

🟥 <Accrual>→<Maturity> (YYYY-MM-DD)

Holds the maturity date of the loan, which is the date on which the last payment is scheduled. All dates are in the form of YYYY-MM-DD, and must be 10 characters long. Hence, a maturity date of February 15, 2020 would be specified as <Maturity>2020-02-15</Maturity>.

Attributes: None

🟦 <PMI>

The PMI element will only appear if PMI has been computed with the loan. Please note that the PMI premiums are not reflected in the amount reported in the <Payment> element, the <PmtStream> element(s), the <TotPmts> element, nor the Pmt attribute of the <AmLine> element.

<PMI Rate="1.00" LTV="100.00" PremiumPerYear="964.08" PremiumPerPeriod="80.34"/>

The element itself contains no data, as all associated PMI data is found in the following attributes:

Attributes: 🔹IndexToRemove, 🔹IndexToWarn, 🔸LTV, 🔸PremiumPerPeriod, 🔸PremiumPerYear, 🔸Rate

🔹 IndexToRemove

This attribute only appears if the PercentToRemove PMI input attribute is specified, and indicates that the payment index on which the remaining principal balance to home value ratio drops below the specified percentage. PMI coverage stops after this payment.

In the sample above, after four payments are made, the ending principal balance to home value ratio drops below 70%, and hence the calculation engine returns IndexToRemove="4". Note that no PMI is included in the amortization schedule for payment numbers four or greater.

🔹 IndexToWarn

This attribute only appears if the PercentToWarn PMI input attribute is specified, and indicates that the payment index on which the remaining principal balance to home value ratio drops below the specified percentage. In the sample above, after three payments are made, the ending principal balance to home value ratio drops below 80%, and hence the calculation engine returns IndexToWarn="3".

🔸 LTV

The loan to value ratio of the computed loan, expressed as a percentage.

🔸 PremiumPerPeriod

The periodic PMI premium amount.

🔸 PremiumPerYear

The annual PMI premium amount

🔸 Rate

The percentage rate used in the PMI calculation.

🟥 <PmtStream>[]

The <PmtStream> element(s) describe the scheduled stream of payments for the computed loan in the order paid. Instead of disclosing each and every payment individually (which can be done with the <AmTable> element), the payment streams group together consecutive equal payments to produce a compressed output view.

The following code translates to "Twelve consecutive payments of $879.31 computed at 10.000% begin on January 22nd, 2024".

<PmtStream Term="12" Pmt="879.31" Rate="10.000" Begin="2024-01-22"/>

Each element describes a single stream of equal payments, using the following attributes to define the important properties of each resulting payment stream:

Attributes: 🔸Begin, 🔸Pmt, 🔸Rate, 🔸Term

🔸 Begin

This attribute contains the date on which the first payment for this given payment stream is scheduled to be made. All dates are in the form of YYYY-MM-DD, and must be 10 characters long. In the example above, the first payment stream is scheduled to begin on September 18, 2005. Hence, the Begin attribute for the first payment stream element would be specified as Begin="2005-09-18".

🔸 Pmt

The Pmt attribute contains the computed payment amount for this payment stream. For the sample payment stream above, the payment amount is 879.31.

🔸 Rate

Contains the interest rate used for the duration of this payment stream. Usually, the interest rate will remain fixed for the duration of the loan unless you are computing an adjustable rate loan or you are computing a LaserPro construction loan with permanent loan attached.

🔸 Term

The Term attribute holds the number of contiguous payments that make up the given payment stream. In the example payment stream above, the term for the stream is 12.

🟦 <ProtectionInfo>[]

These elements (there may be more than one if more than one type of protection was requested) contain information related to the various protection products requested on the given loan. Each element group provides complete results for each requested product (decreasing life, level life, disability/debt cancellation, involuntary unemployment, or personal property).

Attributes: 🔸Formula, 🔸Product, 🔹RateType

🔸 Formula

The Formula attribute contains an abbreviated description of the formula used to compute the desired protection product. The formula codes are described here.

🔸 Product

This attribute informs the calling application to which type of protection product this element refers: decreasing life, level life, disability/debt cancellation, involuntary unemployment or personal property.

🔹 RateType

• Fixed - Protection rate stays constant during the calculations.
• Variable - Protection rate changed from Joint to Single as the loan evolves.

🟥 <ProtectionInfo>→<CalcResult>

This element contains the calculation result for the requested protection product. If it contains a value of Valid Calculation, then the requested product was computed and factored into the loan. Parse the other child elements of <ProtectionInfo> for further details.

A value other than Valid Calculation means that the requested product was not computed with the loan, and the value describes why. In this case, there is no need to parse through the other child elements of <ProtectionInfo>, as the product was not computed.

<CalcResult>Valid Calculation</CalcResult>

Attributes: None

🟥 <ProtectionInfo>→<Cost>

Attributes of this empty element provide the cost of the protection product in total, per payment, and per day. It also provides the rate factor used to compute the premiums.

The only time there will be two <Cost> elements to parse is when the account has been set up to use Plateau’s Uniguard product, and the user has requested joint coverage. If this is the case, then two <Cost> elements are provided to disclose two premiums instead of a single aggregate joint premium.

<Cost Premium="827.26" PerPmt="19.28" PerDay="0.63" Factor="1.0154"/>

Attributes: 🔸Factor, 🔸PerDay, 🔸PerPmt, 🔸Premium

🔸 Factor

The rate factor used to compute the premium for the requested protection product.

🔸 PerDay

The daily cost of coverage, expressed in dollars.

🔸 PerPmt

The cost of coverage expressed as dollars per payment.

🔸 Premium

The total cost for this protection over the term of the loan.

🟥 <ProtectionInfo>→<Coverage>

The aggregate coverage amount and note are provided in the following attributes of this empty element:

<Coverage Amount="75000.00" Note="Partial Coverage of $75,000"/>

Attributes: 🔸Amount, 🔸Note

🔸 Amount

This attribute contains the aggregate coverage amount for this protection product.

🔸 Note

This Note will describe the type of coverage provided. If full coverage has been provided on the aggregate coverage, then the note will contain Full Coverage. Otherwise, the note will describe the type of partial coverage used.

🟥 <ProtectionInfo>→<Benefit>

This empty element will only show up for the disability and involuntary unemployment products.

<Benefit Amount="1000.00" Note="Partial Benefit of $1,000"/>

Attributes: 🔸Amount, 🔸Note, 🔸Periodic

🔸 Amount

Attribute which contains the monthly benefit amount for this protection product.

🔸 Note

This Note will describe the type of coverage provided. If full coverage has been provided on the benefit, then the note will contain Full Coverage. Otherwise, the note will describe the type of partial coverage used.

🔹 Periodic

If the account has been configured to disclose periodic benefits (as opposed to monthly benefit amounts, which are returned in the Amount attribute described above), and if the specified payment frequency is other than monthly, then this attribute will be present and will hold the periodic benefit amount.

🟦 <ProtectionInfo>→<CovTerm>

This empty element provides the calling application with data about the term of coverage for the requested product. If the request has specified the coverage term, then this element will be populated with that term.

<CovTerm InMonths="75" InPmts="75" Maturity="2018-09-22" Note="Truncated: Keep Benefit"/>

Attributes: 🔸InDays, 🔸InMonths, 🔸InPmts, 🔸Maturity, 🔸Note

🔹 InDays

Attribute which expresses the term of coverage in days. This attribute will only be present for the level life product, and even then only if needed (for example, when covering single payment notes).

🔸 InMonths

Contains the term of coverage expressed as a number of months.

🔸 InPmts

Contains the number of payments covered.

🔸 Maturity (YYYY-MM-DD)

This attribute contains the maturity date for the requested coverage. All dates are in the form of YYYY-MM-DD, and must be 10 characters long.

🔸 Note

This Note will describe the type of coverage provided. If full term coverage has been provided, then the note will contain Full Coverage. Otherwise, the note will describe the type of truncated coverage used.

🟦 <ProtectionInfo>→<Borrower>[]

This empty element provides the calling application with data about the term of coverage of a specified borrower, for the requested product. Note that this element will only be present if the input XML request has specified ShowBorrowerInfo= "true", and a valid birthdate was provided. The following attributes are defined for this purpose:

Attributes: 🔸AgeAtIssue, 🔸AgeAtMaturity, 🔸Birthday, 🔸Maturity, 🔸Months, 🔸Note, 🔸Pmts

🔸 AgeAtIssue

If coverage is written on this borrower, then the value of this attribute represents the age at issue of the borrower in a special date-like format of YYYY-MM-DD, where the borrower is YYYY years, MM months, and DD days old when coverage begins.

🔸 AgeAtMaturity

If coverage is written on this borrower, then the value of this attribute represents the age at maturity of the borrower in a special date-like format of YYYY-MM-DD, where the borrower is YYYY years, MM months, and DD days old when coverage terminates.

🔸 Birthday

This attribute contains the birthday associated with the borrower, as specified in the request. All dates are in the form of YYYY-MM-DD, and must be 10 characters long.

🔸 Maturity

The value of this attribute contains the coverage maturity date for this particular borrower.

🔸 Months

Contains the term of coverage expressed as a number of months.

🔸 Note

This Note will describe the type of coverage provided. If full term coverage has been provided, then the note will contain Full Coverage. Otherwise, the note will describe the type of truncated coverage used.

🔸 Pmts

Contains the term of coverage expressed as a number of payments.

🟦 <ProtectionInfo>→<Caps>

This empty element provides the calling application with data about the maximum terms, amounts, and ages associated with the requested product. This element will only be present if the ShowCaps attribute of the <Protection> element is set to true.

<Caps Cov="75000" Ben="1000" Term="84" InceptAge="65" AttainAge="66"/>

Attributes: 🔸AttainAge, 🔸Ben, 🔸Cov, 🔸InceptAge, 🔸Term

🔸 AttainAge

Contains the maximum age a borrower may attain during the term of the loan, expressed in years. If no cap is present or applicable, then a value of zero is returned.

🔸 Ben

Contains the maximum monthly benefit amount, expressed in dollars. If no cap is present or applicable, then a value of zero is returned.

🔸 Cov

Contains the maximum aggregate coverage amount, expressed in dollars. If no cap is present or applicable, then a value of zero is returned.

🔸 InceptAge

Contains the maximum age a borrower may be at loan inception, expressed in years. If no cap is present or applicable, then a value of zero is returned.

🔸 Term

Contains the maximum coverage term, expressed in months. If no cap is present or applicable, then a value of zero is returned.

🟦 <AmTable>

This element (if present) contains child elements which describe the loan's amortization information. This element (and all of its child elements) will only be present if the HideAmort property of the root element of the input query is set to false.

<AmTable> Attributes will only occur as feedback data for Canadian APR's.

Attributes: 🔹AvgBal, 🔹Months, 🔹OddDays, 🔹Weeks

🔹 AvgBal

This attribute will only appear if a Canadian APR is disclosed for the computed loan. The value of this attribute is the average balance of the loan used in the Canadian APR calculation.

🔹 Months

This attribute will only appear if a Canadian APR is disclosed for the computed loan. The value of this attribute is the whole number of months in the term of the loan used in the Canadian APR calculation. Note that the term is expressed in monthly or weekly units, but never both.

🔹 OddDays

This attribute will only appear if a Canadian APR is disclosed for the computed loan. The value of this attribute is the number of odd days in the term of the loan used in the Canadian APR calculation. Odd days are computed by moving backwards from the maturity date the number of disclosed months or weeks, and then counting the additional number of days required to land on the loan date.

🔹 Weeks

This attribute will only appear if a Canadian APR is disclosed for the computed loan. The value of this attribute is the whole number of weeks in the term of the loan used in the Canadian APR calculation. Note that the term is expressed in monthly or weekly units, but never both.

🟦 <AmTable>→<GrandTotals>[]

Describes the total amounts of various categories throughout the life of the loan. As an example, the total amount paid to interest and principal, as well as the total of payments are all contained in the following attributes:

<GrandTotals PmtTot="10551.72" IntTot="551.68" PrinTot="10000.04"/>

Attributes: 🔹AHTot, 🔹CLTot, 🔸IntTot, 🔹IUTot, 🔹PMITot, 🔸PmtTot, 🔸PrinTot, 🔹SCTot

🔹 AHTot

The AHTot attribute will only appear on loans with certain types of accident and health or debt protection products, such as those based on a monthly outstanding balance. It contains the total amount paid for this protection over the duration of the loan.

🔹 CLTot

The CLTot attribute will only appear on loans with certain types of life protection products, such as those based on a monthly outstanding balance. It contains the total amount paid for life over the duration of the loan.

🔸 IntTot

Contains the sum of all interest attributes in the AmLine elements. This amount will be different from the <Interest> element if there is a nonzero EndBal for the final line of amortization. The two will differ by this non-zero EndBal.

🔹 IUTot

The IUTot attribute will only appear on loans with certain types of involuntary unemployment protection products, such as those based on a monthly outstanding balance. It contains the total amount paid for involuntary unemployment over the duration of the loan.

🔹 PMITot

The PMITot attribute will only appear on loans with PMI insurance where the PMI premiums were requested in the amortization schedule. It contains the total PMI amount paid (not including any up front periodic PMI premiums) for PMI over the duration of the loan.

🔸 PmtTot

Contains the total of payments scheduled for the computed loan.

🔸 PrinTot

Like IntTot above, this attribute contains the total amount paid to principal during the loan term, assuming all payments are made as scheduled.

🔹 SCTot

The SCTot attribute will only appear on loans with service charges. It contains the total service charge amount paid over the duration of the loan.

🟦 <AmTable>→<SubTotals>[]

Describes the total amounts of various categories paid during a given calendar year. For each year in which the computed loan has scheduled payments, there will be a <SubTotals> element present. The element itself is empty, as all the interesting categories are found in the following attributes:

<SubTotals Year="2024" Start="1" Events="12" PmtSub="10551.72" IntSub="551.68" PrinSub="10000.04"/>

Attributes: 🔹AHSub, 🔹CLSub, 🔸Events, 🔸IntSub, 🔹IUSub, 🔹PMISub, 🔸PmtSub, 🔸PrinSub, 🔹SCSub, 🔸Start, 🔸Year

🔹 AHSub

The AHSub attribute will only appear on loans with certain types of accident and health or debt protection products, such as those based on a monthly outstanding balance. It contains the total amount paid for this protection during the Year.

🔹 CLSub

The CLSub attribute will only appear on loans with certain types of life protection products, such as those based on a monthly outstanding balance. It contains the total amount paid for life during the Year.

🔸 Events

This attribute defines the number of amortization events (contained in <AmLine> elements which are defined below) which belong to this calendar Year.

🔸 IntSub

Holds the total amount paid to interest over the Year in question, assuming all payments are made as scheduled.

🔹 IUSub

The IUSub attribute will only appear on loans with certain types of involuntary unemployment protection products, such as those based on a monthly outstanding balance. It contains the total amount paid for involuntary unemployment during the Year.

🔹 PMISub

The PMISub attribute will only appear on loans with PMI insurance where the PMI premiums were requested in the amortization schedule. It contains the total PMI amount paid (not including any upfront periodic PMI premiums) for PMI during the Year.

🔸 PmtSub

Contains the total of payments scheduled for the Year in question.

🔸 PrinSub

Like IntSub above, this attribute contains the total amount paid to principal during the Year in question, assuming all payments are made as scheduled.

🔹 SCSub

The SCSub attribute will only appear on loans with service charges. It contains the total of service charges paid during the Year.

🔸 Start

This attribute defines the first amortization event which falls in the specified calendar Year. To find the <AmLine> element which corresponds to this value, match the Idx attribute of the <AmLine> element with the integer value reported by this attribute.

🔸 Year

The given calendar year for which the subtotal data is applicable.

🟥 <AmTable>→<AmLine>[]

There is one <AmLine> element for each amortization event which occurs during the life of a loan. Most of the time, each event will describe a payment, and detail how that payment is applied (to interest, principal, loan protection products, etc.) However, some loan protection methods (TruStage's monthly renewable product, to be exact) have amortization events which correspond to loan protection premiums being added to the loan balance on specific dates.

<AmLine Idx="1" Date="2024-01-01" BegBal="10000.00" Pmt="879.31" Int="84.93" Prin="794.38" EndBal="9205.62"/>

As with the <GrandTotals> and <SubTotals> elements, this element is empty and contains all of the useful information for a given point in the amortization of a loan in the following attributes.

Attributes: 🔹AH, 🔸BegBal, 🔹CL, 🔸Date, 🔸EndBal, 🔸Idx, 🔸Int, 🔹IU, 🔹PMI, 🔸Pmt, 🔸Prin, 🔹SC, 🔹UnpaidInt

🔹 AH

The AH attribute will only appear on loans with certain types of accident and health or debt protection products, such as those based on a monthly outstanding balance. It contains the amount of the payment which is marked for disability/debt protection coverage.

🔸 BegBal

The principal balance before the amortization event occurs.

🔹 CL

The CL attribute will only appear on loans with certain types of life protection products, such as those based on a monthly outstanding balance. It contains the amount of the payment which is marked for life coverage.

🔸 Date

The date on which the amortization event is scheduled to occur. All dates are in the form of YYYY-MM-DD, and must be 10 characters long.

🔸 EndBal

The principal balance amount, after the amortization event has taken place.

🔸 Idx

The index of the amortization event, which is either the payment number, or zero. A value of zero designates a protection premium that was charged on a date other than a payment date. (Occurs with protection category "TrueMOB").

🔸 Int

The amount of the payment which goes to pay interest.

🔹 IU

The IU attribute will only appear on loans with certain types of involuntary unemployment protection products, such as those based on a monthly outstanding balance. It contains the amount of the payment which is marked for this coverage.

🔹 PMI

This attribute contains the PMI premium for this payment.

🔸 Pmt

The amount of the payment (or zero if the event is a "TrueMOB" protection premium).

🔸 Prin

The amount of the payment which goes to reduce the principal balance.

🔹 SC

This attribute contains the total service charge for this payment, and will only be present if one or more service charges were requested with the loan.

🔹 UnpaidInt

This attribute will only appear on an amortization line when interest has been accrued, but has not yet been paid or added to the principal balance. If the interest accrued has not yet been rounded, then the unpaid interest will be displayed to four (4) decimal places. If rounded, then the unpaid interest is displayed to two (2) decimal places.

🟦 <Metavante>

This element will only be present if the Metavante attribute of the root element is set to true. The element itself is empty, as all of the useful information is in the following attributes:

Attributes: 🔸FormsTerm, 🔸HostTerm

🔸 FormsTerm

The number of months in the loan, as computed using the Metavante FORMS method.

🔸 HostTerm

The number of months in the loan, as computed using the Metavante HOST method.