Certificates of Deposit - 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 |
|---|---|
<outCD> | |
<CalcResult> | |
<XMLDetail>[] | |
<PresentValue> | |
<FutureValue> | |
<IntRate> | |
<Term> | 🔸Units |
<Maturity> | |
<Gain> | |
<APY> |
🟥 <outCD>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the response, and is required. This element simply acts as a container for all of the result child elements.
Attributes: None
🟥 <CalcResult>
| Element Type | Data Type |
|---|---|
| Data | Text |
If the calculation was completed successfully, then this element will contain
the value Valid Calculation. Otherwise, this element will contain a
description of the problem encountered during the attempted computation.
Attributes: None
🟦 <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 SCE 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 SCE, and hence
there are no <XMLDetail> elements returned.
Attributes: None
🟥 <PresentValue>
| Element Type | Data Type |
|---|---|
| Data | Currency |
Present value of the CD, representing the initial deposit made on the specified deposit date.
Attributes: None
🟥 <FutureValue>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The future value of the CD at its maturity.
Attributes: None
🟥 <IntRate>
| Element Type | Data Type |
|---|---|
| Data | Decimal |
The rate at which interest will accrue on the CD.
Attributes: None
🟥 <Term>
| Element Type | Data Type |
|---|---|
| Data | Integer |
The value of this element is the number of unit periods (as specified in the
Units attribute) between the deposit date and the CD’s maturity
date.
Attributes:
🔸Units
🔸 Units
| Data Type | Values |
|---|---|
| Enum | years, months, days |
This attribute specifies the units used for the CD’s term. The three options
are: years, months, and days.
🟥 <Maturity>
| Element Type | Data Type |
|---|---|
| Data | Date |
The date of maturity for the CD. All dates are in the form of YYYY-MM-DD, and
must be 10 characters long. Hence, a maturity date of October 27, 2009 is
specified as <Maturity>2009-10-27</Maturity>.
Attributes: None
🟥 <Gain>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The <Gain> is the difference between the future value and the present value.
It is the amount by which the present value increased over the term of the CD.
Attributes: None
🟥 <APY>
| Element Type | Data Type |
|---|---|
| Data | Decimal |
The <APY> (annual percentage yield) is the rate of return on an investment
over the term of a year. The APY takes compounding into account, and if the
compounding frequency is other than annual, the APY will differ from the
interest rate.
Attributes: None