Annual Percentage Yield - 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 |
|---|---|
<outAPY> | |
Results | |
<Description> | |
🟦 <XMLDetail>[] | |
<APY> | 🔸Formula |
<Timeline> | |
<Compounding> | 🔸Frequency |
<Statements> | 🔸Frequency |
<InvestmentDate> | |
<MaturityDate> | 🔸Days |
<Investment> | |
<Interest> | |
<Principal> |
🟥 <outAPY>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the XML APY query result message, 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 | - |
The basic results of the xml calculation are captured as child elements of the "Results" parent.
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.
In our sample output above, no warnings are returned by the SCEX, and hence there are no XMLDetail elements returned.
Attributes: None
🟥 <APY>
| Element Type | Data Type |
|---|---|
| Data | Decimal |
The APY, as defined in Appendix A to Part 1030 of Truth in Savings, and computed by the SCEX. This element has a single attribute, as described below.
Attributes:
🔸Formula
🔸 Formula
| Data Type | Values |
|---|---|
| Enum | General, Special |
The Formula attribute describes the formula used to compute the APY. The General formula is described in Appendix A to Part 1030, Part I Section A. The Special formula is described in Appendix A to Part 1030, Part II Section B. Note that the Special formula is only used when statements are sent more frequently than the deposit is compounded.
🟥 <Timeline>
| Element Type | Data Type |
|---|---|
| Parent | - |
This element contains child elements which describe the timeline of the deposit.
Attributes: None
🟥 <Timeline>→<Compounding>
| Element Type | Data Type |
|---|---|
| Data | Integer |
The value of this element specifies the number of days in each compounding period.
Attributes:
🔸Frequency
🔸 Frequency
| Data Type | Values |
|---|---|
| Enum | Daily, Weekly, BiWeekly, Monthly, BiMonthly, Quarterly, SemiAnnual, Annual |
The value of this attribute specifies the frequency that interest is compounded.
🟥 <Timeline>→<Statements>
| Element Type | Data Type |
|---|---|
| Data | Integer |
The value of this element specifies the number of days in each statement period.
Attributes:
🔸Frequency
🔸 Frequency
| Data Type | Values |
|---|---|
| Enum | Monthly, BiMonthly, Quarterly, SemiAnnual, Annual |
The value of this attribute specifies the frequency that statements are sent to the customer by the deposit institution.
🟦 <Timeline>→<InvestmentDate>
| Element Type | Data Type | Default |
|---|---|---|
| Data | Date | - |
Returns the investment date which was passed into the SCEX. If no investment date was specified, then this element will not appear in the response .
Attributes: None
🟦 <Timeline>→<MaturityDate>
| Element Type | Data Type | Default |
|---|---|---|
| Data | Date | - |
Returns the maturity date which was passed into the SCEX. If no maturity date was specified, then this element will not appear in the response.
Attributes:
🔸Days
🔸 Days
| Element Type | Data Type |
|---|---|
| Data | Integer |
The days attribute contains the number of days between the investment and maturity dates.
🟥 <Investment>
| Element Type | Data Type |
|---|---|
| Parent | - |
This element contains child elements which describe the deposit investment.
Attributes: None
🟥 <Investment>→<Interest>
| Element Type | Data Type |
|---|---|
| Data | Currency |
This element contains the value of the <Interest> element passed into the
SCEX.
Attributes: None
🟥 <Investment>→<Principal>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The value of this element specifies the total amount earning interest.
Attributes: None