Dealer Reserve - 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.
| Element | Attributes |
|---|---|
<outDEALER_RESERVE> | |
<Results> | |
<Description> | |
<XMLDetail>[] | |
<GrossReserve> | |
<DealerReserve> | 🔸FlatFeeUsed |
<BankReserve> | |
<RegZAPR> | 🔸APRCheck |
🟥 <outDEALER_RESERVE>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the XML response, and is required. This element simply acts as a container for all of the result child elements.
Attributes: None
🟥 <Results>
| Element Type | Data Type |
|---|---|
| Parent | - |
This element contains child elements which describe the success or failure of the calculation, as well as any XML messages.
Attributes: None
🟥 <Results>→<Description>
| Element Type | Data Type |
|---|---|
| Data | Text |
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>[]
| 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
🟥 <GrossReserve>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The Gross Dealer Reserve is returned in this element. This reserve represents the total reserve before being distributed between the bank and the dealer.
Attributes: None
🟥 <DealerReserve>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The portion of the gross reserve dedicated to the dealer is reported in this element. The calculation is as follows: Dealer Reserve = GrossReserve * ReservePercent - ProcFee.
Attributes:
🔸FlatFeeUsed
🔸 FlatFeeUsed
| Data Type | Values |
|---|---|
| Boolean | true, false |
This attribute of the Dealer Reserve element informs the calling application if the disclosed Dealer Reserve is the result of a calculation (false or 0) or a flat fee passed as input (true or 1).
🟥 <BankReserve>
| Element Type | Data Type |
|---|---|
| Data | Currency |
This element discloses the amount of the Gross Reserve owed to the Bank.
Attributes: None
🟥 <RegZAPR>
| Element Type | Data Type |
|---|---|
| Data | Decimal |
The computed Regulation Z APR of the original loan made to the borrower.
Attributes:
🔸APRCheck
🔸 APRCheck
| Data Type | Values |
|---|---|
| Enum | pass, fail, untested |
If the APR entered during input (see <NoteRate>) is
within compliance of Regulation Z, this attribute value will be set to pass;
otherwise, fail will be reported. If an error was reported during the
calculation and the data was not adequate to make the test, untested will be
reported.