Open End Lending - Response

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.

🟥 <outOpenEnd>

This is the root element of the XML open end query result message, and is required. This element simply acts as a container for all of the result child elements.

Attributes: None

🟥 <Results>

This element contains child elements which describe the success or failure of the calculation, as well as any XML messages.

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.

In our sample output above, no warnings are returned by the SCEX, and hence there are no <XMLDetail> elements returned.

Attributes: None

🟦 <RegZAPR>

The computed effective annual percentage rate (APR). The SCEX will return this element if the number of billing cycles per year (see BCPY) has been specified, and is greater than zero.

Attributes: 🔸FinChg

🔸 FinChg

The computed finance charge used in the calculation of the effective APR. This is the sum of the interest charge and all finance charge affecting fees.

🟦 <MAPR>

If the military APR has been requested (see UseMAPR) and a valid number of billing cycles per year (see BCPY) has been specified, then this element will be included in the output. The value of the element is the military APR, and the element has the following attributes:

Attributes: 🔸FinChg, 🔸Max, 🔸MaxExceeded

🔸 FinChg

The computed "military finance charge", used in the calculation of the MAPR. This is the sum of the interest charge, all finance charge affecting fees, all MAPR affecting fees, and all protection premiums/fees.

🔸 Max

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

🔸 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 open-end loan was 37.125%, the <MAPR> element would be:

<MAPR FinChg="375.00" Max="36.000" MaxExceeded="true">37.125</MAPR>.

🟦 <FinChgFees>

The value of this element contains the sum of all fees which affect the Finance Charge. This element will only be present in the output if the value is greater than zero.

Attributes: None

🟦 <MAPRFees>

The value of this element contains the sum of all fees which affect the Military APR. This element will only be present in the output if the value is greater than zero, and the Military APR has been disclosed.

Attributes: None

🟦 <PocketFees>

This element holds the sum of all fees which do not affect the finance charge. If no out of pocket fees were requested, then this element will not show up in the XML output.

Attributes: None

🟦 <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 XML request. If no such attribute is present in the request element, then none will be present in the response element.

🟦 <PaymentInfo>

This element groups together payment result amounts, such as the amount to principal, interest, protection, and total payment.

Attributes: None

🟦 <PaymentInfo>→<Balance>

This element contains the computed balance, and only appears when the <Limit> element is present in the input XML query.

Attributes: None

🟥 <PaymentInfo>→<Interest>

This element contains the total interest accrued during the payment period, assuming the borrower makes the scheduled payment on time.

Attributes: 🔸Method

🔸 Method

The Method attribute contains a textual description of the interest accrual method.

🟥 <PaymentInfo>→<PrinReduction>

The amount of the payment which reduces the principal balance.

Attributes: None

🟥 <PaymentInfo>→<TotProtection>

Contains the total cost of all protection plans included with the computed loan. For the individual plan costs, see the <ProtectionInfo> elements described below.

Attributes: 🔸PerDay

🔸 PerDay

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

🟥 <PaymentInfo>→<Payment>

This element holds the total computed payment, which includes the <Interest> and <TotProtection> element values.

Attributes: 🔸Date, 🔸Days, 🔸Warning

🔸 Date

Holds the date on which the payment is scheduled. All dates are in the form of YYYY-MM-DD, and must be 10 characters long. Hence, a payment date of April 15, 2009 would be disclosed as Date="2009-04-15".

🔸 Days

Returns the number of days used in the calculation of interest. Note that this value not be the actual number of days between the begin date and payment date for accrual codes 204 and 205.

🔸 Warning

Any special conditions encountered while computing the payment will be reported in this attribute. A value of None indicates that no special conditions were triggered. The FloorPmt value means that the calculated payment was less than the specified floor payment (see the FloorPmt attribute of the <Payment>). A value of NegativeAm indicates that the computed payment is less than the accrued interest.

🟥 <PaymentInfo>→<Payoff>

The maximum payment (which will pay off the open end loan if paid on schedule) is contained within this element. Note that this payment includes the <Interest> and <TotProtection> element values.

Attributes: None

🟦 <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 open end loan. Each element provides information for one of the protection products (life, disability, or job loss) in its attributes or child elements.

Attributes: 🔹Age, 🔸Product,

🔹 Age

This attribute contains the age used to compute the protection fee. If age is not taken into consideration when computing the protection fee, then this attribute will not appear.

🔸 Product

This attribute informs the calling application to which type of protection product this element refers: life, disability, or job loss.

🟥 <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.

Attributes: None

🟥 <ProtectionInfo>→<Cost>

Attributes of this empty element provide the cost of the protection product in total.

Attributes: 🔸Factor, 🔸PerDay, 🔸Premium

🔸 Premium

The total cost for this protection.

🔸 PerDay

The daily cost of protection, expressed in dollars.

🔸 Factor

The rate factor stored in the setup file used to compute the fee for the requested protection product is contained in this attribute.

🟥 <ProtectionInfo>→<Coverage>

The aggregate coverage amount is provided in the following attribute of this empty element:

Attributes: 🔸Amount, 🔸Note

🔸 Amount

Attribute which contains the aggregate coverage amount for this protection product. In the example open end output, the life coverage amount is returned as Amount="10000.00".

🔸 Note

This Note will describe the type of protection provided. If full coverage has been provided, then the note will contain Full Coverage. Otherwise, the note will describe the type of partial coverage used. In our example open end calculation, life, disability, and job loss products did not encounter a cap, hence producing the following output: Note="Full Coverage".

🟦 <ProtectionInfo>→<Benefit>

This empty element will only show up for the disability and job loss products. The attributes of this element which contain benefit information are:

Attributes: 🔸Amount, 🔸Note

🔸 Amount

Attribute which contains the benefit amount for this protection product. In the example loan output, the disability benefit amount is returned as Amount="750.00".

🔸 Note

This attribute will describe the type of protection 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. In our example open end calculation, the disability benefit was capped at $750, producing the following output: Note="Partial Benefit of $750".

🟦 <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.

Attributes: 🔸Ben, 🔸Cov, 🔸InceptAge

🔸 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.