Deposit - Schema Documentation - V4.5.Revision
Documents generated: 4/9/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/Deposit.xsd
Version 4.5.Revision
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://cufxstandards.com/v4/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v4/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v4/Relationship.xsd (at Relationship.xsd)
    • http://cufxstandards.com/v4/Contact.xsd (at Contact.xsd)
    • http://cufxstandards.com/v4/Party.xsd (at Party.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/Deposit.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v4/Common.xsd
account http://cufxstandards.com/v4/Account.xsd
relationship http://cufxstandards.com/v4/Relationship.xsd
contact http://cufxstandards.com/v4/Contact.xsd
party http://cufxstandards.com/v4/Party.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/Deposit.xsd" version="4.5.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v4/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Account.xsd" schemaLocation="Account.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Relationship.xsd" schemaLocation="Relationship.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Contact.xsd" schemaLocation="Contact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v4/Party.xsd" schemaLocation="Party.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: deposit

Name deposit
Type Deposit
Nillable no
Abstract no
Documentation Top level element for the details relating to a deposit account. This element definition is not needed and is not consistant with the format of the standard. Use of this global element definition is deprecated and will be removed with release v5.0.
JSON Instance Representation
{deposit
<!-- 'account:Account' super type was not found in this schema. Some elements and attributes may be missing. -->
"depositPartyList" : DepositPartyList , [0..1] ?
"bumpEffectiveDate" : xs:date , [0..1] ?
"bumpExpirationDate" : xs:date , [0..1] ?
"bumpRate" : xs:decimal , [0..1] ?
"dividendPostCode" : DividendPostCodeType , [0..1] ?
"dividendRate" : xs:decimal , [0..1] ?
"annualPercentageYield" : xs:decimal , [0..1] ?
"dividendTransferAccountId" : account:AccountId , [0..1] ?
"dividendType" : xs:string , [0..1] ?
"irsCode" : xs:string , [0..1] ?
"maturityPostCode" : MaturityPostCodeType , [0..1] ?
"maturityTransferAccountId" : account:AccountId , [0..1] ?
"minimumDeposit" : common:Money , [0..1] ?
"minimumWithdrawal" : common:Money , [0..1] ?
"overdraftTolerance" : common:Money , [0..1] ?
"maturityTransferAmount" : common:Money , [0..1] ?
"maturityTransferPercent" : xs:decimal , [0..1] ?
"serviceChargeWaivedReason" : xs:string , [0..1] ?
deposit}
Schema Component Representation
<xs:element name="deposit" type="Deposit"/>
top

Element: depositList

Name depositList
Type DepositList
Nillable no
Abstract no
Documentation Top level deposit list collection element.
JSON Instance Representation
{depositList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"deposit" : Deposit , [0..*] ?
depositList}
Schema Component Representation
<xs:element name="depositList" type="DepositList"/>
top

Global Definitions

Complex Type: Deposit

Name Deposit
Abstract no
Documentation Details relating to a deposit account.
JSON Instance Representation
{
<!-- 'account:Account' super type was not found in this schema. Some elements and attributes may be missing. -->
"depositPartyList" : DepositPartyList , [0..1] ?
"bumpEffectiveDate" : xs:date , [0..1] ?
"bumpExpirationDate" : xs:date , [0..1] ?
"bumpRate" : xs:decimal , [0..1] ?
"dividendPostCode" : DividendPostCodeType , [0..1] ?
"dividendRate" : xs:decimal , [0..1] ?
"annualPercentageYield" : xs:decimal , [0..1] ?
"dividendTransferAccountId" : account:AccountId , [0..1] ?
"dividendType" : xs:string , [0..1] ?
"irsCode" : xs:string , [0..1] ?
"maturityPostCode" : MaturityPostCodeType , [0..1] ?
"maturityTransferAccountId" : account:AccountId , [0..1] ?
"minimumDeposit" : common:Money , [0..1] ?
"minimumWithdrawal" : common:Money , [0..1] ?
"overdraftTolerance" : common:Money , [0..1] ?
"maturityTransferAmount" : common:Money , [0..1] ?
"maturityTransferPercent" : xs:decimal , [0..1] ?
"serviceChargeWaivedReason" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Deposit">
<xs:complexContent>
<xs:extension base="account:Account">
<xs:sequence>
<xs:element name="depositPartyList" type="DepositPartyList" minOccurs="0" maxOccurs="1"/>
<xs:element name="bumpEffectiveDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="bumpExpirationDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="bumpRate" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="dividendPostCode" type="DividendPostCodeType" minOccurs="0" maxOccurs="1"/>
<xs:element name="dividendRate" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="annualPercentageYield" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="dividendTransferAccountId" type="account:AccountId" minOccurs="0" maxOccurs="1"/>
<xs:element name="dividendType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="irsCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="maturityPostCode" type="MaturityPostCodeType" minOccurs="0" maxOccurs="1"/>
<xs:element name="maturityTransferAccountId" type="account:AccountId" minOccurs="0" maxOccurs="1"/>
<xs:element name="minimumDeposit" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="minimumWithdrawal" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="overdraftTolerance" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="maturityTransferAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="maturityTransferPercent" type="xs:decimal" minOccurs="0" maxOccurs="1" default="1.00"/>
<xs:element name="serviceChargeWaivedReason" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DepositList

Name DepositList
Abstract no
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"deposit" : Deposit , [0..*] ?
}
Schema Component Representation
<xs:complexType name="DepositList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="deposit" type="Deposit" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DepositParty

Name DepositParty
Abstract no
Documentation This object points to the party and how it relates to the deposit.
JSON Instance Representation
{
"depositPartyId" : party:PartyId , [0..1] ?
"depositPartyRelationshipType" : DepositPartyRelationshipType , [0..1] ?
"ssnOverride" : xs:boolean , [0..1] ?
"contactIdList" : contact:ContactIdList , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="DepositParty">
<xs:sequence>
<xs:element name="depositPartyId" type="party:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="depositPartyRelationshipType" type="DepositPartyRelationshipType" minOccurs="0" maxOccurs="1"/>
<xs:element name="ssnOverride" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false"/>
<xs:element name="contactIdList" type="contact:ContactIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: DepositPartyList

Name DepositPartyList
Abstract no
Documentation A collection of party ID’s that uniquely identify each party associated to this deposit and additional fields on how the party relates to the deposit. This list is in addition to the relationship parties if available.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"depositParty" : DepositParty , [0..*] ?
}
Schema Component Representation
<xs:complexType name="DepositPartyList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="depositParty" type="DepositParty" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DepositPartyRelationshipType

Name DepositPartyRelationshipType
Abstract no
Documentation The party relationship type is the textual representation of what the party record represents to this loan, such as primary, co-borrower, beneficiary or some other type of relationship. This value may be visible to the user and must be human-readable. If the same party exists at the relationship level, the account level relationship type overrides the relationship. Intended choice - Due to cross language serialization issues the choice construct has been removed. It is the responsibility of the implementer to add programmatic logic for this complex type to detect, handle and or error when population of more than one element is present.
JSON Instance Representation
{
"holder" : relationship:Holder , [0..1] ?
"beneficiary" : relationship:Beneficiary , [0..1] ?
"agent" : common:Agent , [0..1] ?
"guarantor" : relationship:Guarantor , [0..1] ?
"safeDepositBoxUser" : relationship:SafeDepositBoxUser , [0..1] ?
}
Schema Component Representation
<xs:complexType name="DepositPartyRelationshipType">
<xs:sequence>
<xs:element name="holder" type="relationship:Holder" minOccurs="0" maxOccurs="1"/>
<xs:element name="beneficiary" type="relationship:Beneficiary" minOccurs="0" maxOccurs="1"/>
<xs:element name="agent" type="common:Agent" minOccurs="0" maxOccurs="1"/>
<xs:element name="guarantor" type="relationship:Guarantor" minOccurs="0" maxOccurs="1"/>
<xs:element name="safeDepositBoxUser" type="relationship:SafeDepositBoxUser" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Simple Type: DividendPostCodeType

Name DividendPostCodeType
Content
  • Base XSD Type: string
  • value comes from list: {'ToAccount'|'ByCheck'|'Transfer'|'Forfeit'}
Documentation Provides types for posting dividends earned on the account.
Schema Component Representation
<xs:simpleType name="DividendPostCodeType">
<xs:restriction base="xs:string">
<xs:enumeration value="ToAccount"/>
<xs:enumeration value="ByCheck"/>
<xs:enumeration value="Transfer"/>
<xs:enumeration value="Forfeit"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: MaturityPostCodeType

Name MaturityPostCodeType
Content
  • Base XSD Type: string
  • value comes from list: {'Renew'|'ByCheck'|'Transfer'|'Suspend'|'TransferAndRenew'}
Documentation Provides types for posting the account balance upon maturity.
Schema Component Representation
<xs:simpleType name="MaturityPostCodeType">
<xs:restriction base="xs:string">
<xs:enumeration value="Renew"/>
<xs:enumeration value="ByCheck"/>
<xs:enumeration value="Transfer"/>
<xs:enumeration value="Suspend"/>
<xs:enumeration value="TransferAndRenew"/>
</xs:restriction>
</xs:simpleType>
top