Refunds - 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.
🟥 <outREFUND>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the XML refund query input message and is required. This contains child elements which specify the particulars of the requested refund. The following attributes of the <inREFUND> element are defined:
Attributes: None
🟥 <CalcResult>
| Element Type | Data Type |
|---|---|
| Data | Text |
If the calculation was completed successfully, then this element will contain
the value Successful Calculation, and the Code attribute will hold a value of
zero (0).
Otherwise, this element will contain a description of the problem encountered during the attempted computation. Please consult the attributes of this element for further information.
Attributes:
🔹Attribute,🔸Code,🔹Element,🔹Mode
🔹 Attribute
| Data Type | Default |
|---|---|
| Text | n/a |
This attribute will be present only when the calculation was not completed successfully (i.e., the value of the Code attribute is a value other than zero (0)).
🔸 Code
| Data Type | Values |
|---|---|
| Integer | [0..31] |
A value of zero (0) indicates a successful calculation, and the Mode, Element, and Attribute attributes will not be present. A value greater than zero indicates an error condition. Please consult Table 27.2 for the allowed values of this attribute and their meanings. Also, the Mode, Element, and Attribute attributes may hold useful information for tracking down the issue.
| Code | Description |
|---|---|
| 0 | Refund calculation computed successfully. |
| 1 | Unexpected system error. |
| 2 | Unexpected SCEX error. |
| 3 | XML input validation against the DTD has failed, XML input is invalid. |
| 4 | Invalid payments per year specified. |
| 5 | Scheduled number of payments must be greater than zero (0). |
| 6 | Scheduled number of payments cannot be greater than the loan term. |
| 7 | Specified attribute is not in the list of valid attributes for this element. |
| 8 | Unknown coverage type specified. |
| 9 | Unknown premium method specified. |
| 10 | Invalid loan type specified. |
| 11 | Invalid formula type specified. |
| 12 | Payment date is before loan date. |
| 13 | Refund date is before loan date. |
| 14 | Term must be greater than zero (0). |
| 15 | Amortization term must be greater than zero (0). |
| 16 | Amortization term must be greater than or equal to term. |
| 17 | Payment must be greater than zero (0). |
| 18 | Balloon must be greater than or equal to zero (0). |
| 19 | Premium cannot be less than zero (0). |
| 20 | Coverage must be greater than zero (0). |
| 21 | AH plan must be greater than or equal to one (1). |
| 22 | Unknown element specified. |
| 23 | Unknown attribute specified. |
| 24 | All premiums are zero (0) - no refunds computed. |
| 25 | Cannot load CL setup file. |
| 26 | Cannot load AH setup file. |
| 27 | Cannot load refund setup file. |
| 28 | Zero (0) denominator in CL_CUNA_NonBalloon() routine. |
| 29 | AH rule of anticipation - original term in months is zero (0). |
| 30 | AH rule of anticipation - rate at original term is zero (0). |
| 31 | Rule of anticipation method is not allowed for this product. |
🔹 Element
| Data Type | Default |
|---|---|
| Text | n/a |
This attribute will be present only when the calculation was not completed
successfully (i.e., the value of the Code attribute is a value other than zero
(0)) and the value of the Mode attribute is ParseInput. If present, the value
of this attribute informs the calling application the element of the XML input
in which the XML parsing error occurred.
🔹 Mode
| Data Type | Values | Default |
|---|---|---|
| Enum | ParseInput, Calculate, LoadOutput | ParseInput |
If the calculation was not completed successfully (i.e., the value of the Code attribute is a value other than zero (0)), then this attribute will be present. The value of this attribute informs the calling application the general area during which the error was encountered. The potential values for this attribute are:
-
ParseInput- Error encountered while parsing the XML input. TheElementattribute will be present indicating the element in which the error occurred. TheAttributeattribute also may be present, if the input parsing error relates to an attribute specified in the input XML. -
Calculate- Error encountered while attempting to compute the refund. TheElementandAttributeattributes will not be present. -
LoadOutput— Error encountered while attempting to build and return the XML output. TheElementandAttributeattributes will not be present.
🟦 <XMLDetail>[]
| Element Type | Data Type | Default |
|---|---|---|
| Data | Text | NULL |
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
🟥 <TotalRefund>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The value of this element is the computed decreasing credit life refund due to the borrower. This element will only be returned if the specified decreasing credit life premium is greater than zero.
Attributes:
🔸RemainingPmts
🔸 RemainingPmts
| Data Type |
|---|
| Integer |
The value of this attribute is the computed term of coverage beyond the specified refund date, and is used in the computation of the refund amount.
🟦 <CLRefund>
| Element Type | Data Type | Default |
|---|---|---|
| Data | Currency | 0 |
The value of this element is the computed decreasing credit life refund due to the borrower. This element will only be returned if the specified decreasing credit life premium is greater than zero.
Attributes:
🔸RemainingPmts
🔸 RemainingPmts
| Data Type |
|---|
| Integer |
The value of this attribute is the computed term of coverage beyond the specified refund date, and is used in the computation of the refund amount.
<LLRefund>
| Element Type | Data Type | Default |
|---|---|---|
| Data | Currency | 0 |
The value of this element is the computed level credit life refund due to the borrower. This element will only be returned if the specified level credit life premium is greater than zero.
Attributes:
🔸RemainingPmts🔸RemainingPmts
🔹 Remaining
| Data Type | Default |
|---|---|
| Integer | 0 |
With single payment notes calibrated in days, the "Remaining" number of days of coverage after refund are reported in this attribute.
🔹 RemainingPmts
| Data Type | Default |
|---|---|
| Integer | 0 |
The value of this attribute is the computed term of coverage beyond the specified refund date, and is used in the computation of the refund amount.
🟦 <AHRefund>
| Element Type | Data Type | Default |
|---|---|---|
| Data | Currency | 0 |
The value of this element is the computed disability refund due to the borrower. This element will only be returned if the specified disability premium is greater than zero.
Attributes:
🔸RemainingPmts
🔸 RemainingPmts
| Data Type |
|---|
| Integer |
The value of this attribute is the computed term of coverage beyond the specified refund date, and is used in the computation of the refund amount.
🟦 <IURefund>
| Element Type | Data Type | Default |
|---|---|---|
| Data | Currency | 0 |
The value of this element is the computed involuntary unemployment refund due to the borrower. This element will only be returned if the specified involuntary unemployment premium is greater than zero.
Attributes:
🔸RemainingPmts
🔸 RemainingPmts
| Data Type |
|---|
| Integer |
The value of this attribute is the computed term of coverage beyond the specified refund date, and is used in the computation of the refund amount.
🟦 <PPRefund>
| Element Type | Data Type | Default |
|---|---|---|
| Data | Currency | 0 |
The value of this element is the computed personal property refund due to the borrower. This element will only be returned if the specified personal property premium is greater than zero.
Attributes:
🔸RemainingPmts
🔸 RemainingPmts
| Data Type |
|---|
| Integer |
The value of this attribute is the computed term of coverage beyond the specified refund date, and is used in the computation of the refund amount.