Annual Percentage Yield - Request
Please see the Legend to understand the conventions used to document each element and attribute. Note that for requests, the XML elements are documented in alphabetical order by parent element.
| Element | Attributes |
|---|---|
<inAPY> | 🔹Compounding, 🔹DecAccuracy, 🔹Statement |
<Format> | 🔹CurrencyDecimals, 🔹DateFormat, 🔹DateSeparator, 🔹DecimalSeparator, 🔹StrictDP, 🔹ThousandSeparator |
<Interest> | |
<InvestDate> | |
<MaturityDate> | |
<Principal> |
🟥 <inAPY>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the request, and is required. This contains
child elements which specify the particulars of the requested APY. The following
attributes of the <inAPY> element are defined:
Attributes:
🔹Compounding,🔹DecAccuracy,🔹Statement
🔹 Compounding
| Data Type | Values | Default |
|---|---|---|
| Enum | Daily, Weekly, BiWeekly, Monthly, BiMonthly, Quarterly, SemiAnnual, Annual | Daily |
The Compounding attribute specifies the frequency that interest is compounded.
If the deposit compounds continuously, then specify a value of Daily.
🔹 DecAccuracy
| Data Type | Values | Default |
|---|---|---|
| Integer | [3..5] | 3 |
The number of decimal places of accuracy for the disclosed APY is determined by this attribute.
🔹 Statement
| Data Type | Values | Default |
|---|---|---|
| Enum | Monthly, BiMonthly, Quarterly, SemiAnnual, Annual | Monthly |
The Statement attribute determines the frequency that statements are provided to
the customer by the deposit institution.
🟦 <Format>
| Element Type | Data Type | Values | Default |
|---|---|---|---|
| Empty | - | - | see attribute defaults |
The <Format> element is one of the first elements parsed from a request, as the
attributes of this empty element affect how date and numeric values are parsed
and validated.
Attributes:
🔹CurrencyDecimals,🔹DateFormat,🔹DateSeparator,🔹DecimalSeparator,🔹StrictDP,🔹ThousandSeparator
🔹 CurrencyDecimals
| Data Type | Values | Default |
|---|---|---|
| Enum | 0, 2 | 2 |
When displaying and parsing Currency values, the value of this attribute
determines the maximum number of decimal places allowed after the
DecimalSeparator.
🔹 DateFormat
| Data Type | Values | Default |
|---|---|---|
| Enum | YMD, MDY, DMY | YMD |
When displaying and parsing Date values, this field determines the expected
format for all Date fields. The following DateFormat options are allowed:
YMD- All dates should be formatted as YYYY-MM-DD.MDY- All dates should be formatted as MM-DD-YYYY.DMY- All dates should be formatted as DD-MM-YYYY.
Note that the character which separates the individual month, day, and year
portions of the date is configurable via the
DateSeparator attribute.
🔹 DateSeparator
| Data Type | Values | Default |
|---|---|---|
| Char | One character | - |
When displaying and parsing Date values, this attribute determines the character used to separate the individual month, day, and year portions of a date.
🔹 DecimalSeparator
| Data Type | Values | Default |
|---|---|---|
| Char | One character | . |
When displaying and parsing Currency or Decimal numeric values, this attribute determines the character used to separate the fractional part from the whole.
🔹 StrictDP
| Data Type | Values | Default |
|---|---|---|
| Boolean | true, false, 1, 0 | false |
If the value of this attribute is true, then the SCE will strictly verify the
number of decimal places allowed for currency input values. Thus, if the calling
application sends in a request with a currency amount of 1000.005, the SCE
will return an error code.
If the value of this attribute is false, then currency values sent in with an
invalid number of decimal places will be rounded to the correct number of
decimal places by the SCE (using five/four rounding), and a warning message with
this information will be returned with the response.
🔹 ThousandSeparator
| Data Type | Values | Default |
|---|---|---|
| Char | One character | , |
When displaying numeric values, this attribute determines the character used to separate the thousands places from the hundreds. Note that when parsing numeric values, the value of this attribute is ignored.
🟥 <Interest>
| Element Type | Data Type | Values |
|---|---|---|
| Data | Currency | >= 0 |
The total interest earned on the principal (a) for the entire duration of the deposit if the compounding frequency is greater than or equal to the statement disclosure frequency, or (b) for the statement period if statements are disclosed more frequently than the deposit is compounded.
Attributes: None
🟦 <InvestDate>
| Element Type | Data Type | Values | Default |
|---|---|---|---|
| Data | Date | >= 1900-01-01 | - |
This optional element contains the date on which interest accrual begins. If statements are disbursed more frequently than interest is compounded, then you may omit this element. As an example, if interest is compounded annually and statements are disclosed monthly, then this element may be omitted.
All dates must be in the form of YYYY-MM-DD, and be 10 characters long. Hence,
an investment date of April 16, 2014 would be specified as
<InvestDate>2015-04-16</InvestDate>.
Attributes: None
🟦 <MaturityDate>
| Element Type | Data Type | Values | Default |
|---|---|---|---|
| Data | Date | >= 1900-01-01 | - |
This optional element contains the date on which the deposit matures. If statements are disbursed more frequently than interest is compounded, then you may omit this element. As an example, if interest is compounded annually and statements are disclosed monthly, then this element may be omitted.
All dates must be in the form of YYYY-MM-DD, and be 10 characters long. Hence, a
maturity date of April 16, 2015 would be specified as
<MaturityDate>2014-04-16</MaturityDate>.
Attributes: None
🟥 <Principal>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The value of this element specifies the total amount earning interest.
Attributes: None