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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/FinancialInstitution.xsd
Version 4.5.Revision:1311
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/Party.xsd (at Party.xsd)

Declared Namespaces

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

Global Declarations

Element: fiList

Name fiList
Type FinancialInstitutionList
Nillable no
Abstract no
Documentation The master list of financial institutions available in the CUFX instance. A financial institution must be in a specific configuration list to have access to a specific set of data.
JSON Instance Representation
{fiList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"financialInstitution" : FinancialInstitution , [0..*] ?
fiList}
Schema Component Representation
<xs:element name="fiList" type="FinancialInstitutionList"/>
top

Global Definitions

Complex Type: FinancialInstitution

Name FinancialInstitution
Abstract no
JSON Instance Representation
{
"fiId" : common:FinancialInstitutionId , [0..1] ?
"fiName" : FinancialInstitutionName , [0..1] ?
"fiDescription" : xs:string , [0..1] ?
"fiOrganizationType" : party:OrganizationType , [0..1] ?
"fiStatus" : FinancialInstitutionStatus , [0..1] ?
"fiStatusComment" : FinancialInstitutionStatusComment , [0..1] ?
"fiTimeZoneUTCOffset" : common:TimeZoneUTCOffset , [0..1] ?
"partyId" : party:PartyId , [0..1] ?
"fiCurrencySupportList" : common:CurrencyList , [0..1] ?
"fiAcceptLanguageList" : common:LanguageList , [0..1] ?
"fiCreatedDateTime" : xs:dateTime , [0..1] ?
"fiCreatedBy" : common:UserId , [0..1] ?
"fiLastUpdatedDateTime" : xs:dateTime , [0..1] ?
"fiLastUpdatedBy" : common:UserId , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="FinancialInstitution">
<xs:sequence>
<xs:element name="fiId" type="common:FinancialInstitutionId" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiName" type="FinancialInstitutionName" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiOrganizationType" type="party:OrganizationType" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiStatus" type="FinancialInstitutionStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiStatusComment" type="FinancialInstitutionStatusComment" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiTimeZoneUTCOffset" type="common:TimeZoneUTCOffset" minOccurs="0" maxOccurs="1"/>
<xs:element name="partyId" type="party:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiCurrencySupportList" type="common:CurrencyList" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiAcceptLanguageList" type="common:LanguageList" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiCreatedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiCreatedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiLastUpdatedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="fiLastUpdatedBy" type="common:UserId" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: FinancialInstitutionIdList

Name FinancialInstitutionIdList
Abstract no
Documentation The list of financial institutions IDs that should have their associated financial institution records either returned or affected by a read, update or delete financial institution request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fiId" : common:FinancialInstitutionId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FinancialInstitutionIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fiId" type="common:FinancialInstitutionId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FinancialInstitutionList

Name FinancialInstitutionList
Abstract no
Documentation The master list of financial institutions available in the CUFX instance. A financial institution must be in a configuration list to have access to a specific set of data.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"financialInstitution" : FinancialInstitution , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FinancialInstitutionList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="financialInstitution" type="FinancialInstitution" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FinancialInstitutionNameList

Name FinancialInstitutionNameList
Abstract no
Documentation The list of financial institution names that should have their associated financial institution records either returned or affected by a read, update or delete financial institution request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fiName" : FinancialInstitutionName , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FinancialInstitutionNameList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fiName" type="FinancialInstitutionName" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: FinancialInstitutionStatusList

Name FinancialInstitutionStatusList
Abstract no
Documentation The list of financial institution statuses that should have their associated financial institution records either returned or affected by a read, update or delete financial institution request.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"fiStatus" : FinancialInstitutionStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="FinancialInstitutionStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="fiStatus" type="FinancialInstitutionStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: FinancialInstitutionName

Name FinancialInstitutionName
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="FinancialInstitutionName">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: FinancialInstitutionStatus

Name FinancialInstitutionStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Online'|'Offline'|'Deleted'|'Other'}
Schema Component Representation
<xs:simpleType name="FinancialInstitutionStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Online"/>
<xs:enumeration value="Offline"/>
<xs:enumeration value="Deleted"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: FinancialInstitutionStatusComment

Name FinancialInstitutionStatusComment
Content
  • Base XSD Type: string
Schema Component Representation
<xs:simpleType name="FinancialInstitutionStatusComment">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top