ProductOffering - Schema Documentation - V5.0.Revision
Documents generated: 6/7/2021

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/ProductOffering.xsd
Version 5.0.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/v5/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v5/Account.xsd (at Account.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/ProductOffering.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
account http://cufxstandards.com/v5/Account.xsd
common http://cufxstandards.com/v5/Common.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/ProductOffering.xsd" version="5.0.$Revision$" elementFormDefault="qualified">
<xs:import namespace="http://cufxstandards.com/v5/Common.xsd" schemaLocation="Common.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Account.xsd" schemaLocation="Account.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: productOfferingList

Name productOfferingList
Type ProductOfferingList
Nillable no
Abstract no
Documentation The product offering collection/array contains all the possible product types for an instance that the credential set is authorized to access at the institution based on applied filters.
JSON Instance Representation
{productOfferingList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productOffering" : ProductOffering , [0..*] ?
productOfferingList}
Schema Component Representation
<xs:element name="productOfferingList" type="ProductOfferingList"/>
top

Global Definitions

Complex Type: InterestRate

Name InterestRate
Abstract no
Documentation Defines the interest rate fields for a product offering at the institution level.
JSON Instance Representation
{
"interestRateId" : xs:string , [0..1] ?
"interestPointsRewardsProgram" : xs:boolean , [0..1] ?
"introductoryRate" : xs:boolean , [0..1] ?
"balanceConsolidationRate" : xs:boolean , [0..1] ?
"riskRate" : xs:boolean , [0..1] ?
"riskRateClassificationMinimum" : xs:string , [0..1] ?
"riskRateClassificationMaximum" : xs:string , [0..1] ?
"interestRateDescription" : xs:string , [0..1] ?
"interestRateCriteria" : xs:string , [0..1] ?
"minimumBalance" : common:Money , [0..1] ?
"maximumBalance" : common:Money , [0..1] ?
"term" : xs:duration , [0..1] ?
"effectiveDateTime" : xs:dateTime , [0..1] ?
"expirationDateTime" : xs:dateTime , [0..1] ?
"interestRate" : xs:decimal , [0..1] ?
"annualPercentageRate" : common:AnnualPercentageRate , [0..1] ?
}
Schema Component Representation
<xs:complexType name="InterestRate">
<xs:sequence>
<xs:element name="interestRateId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="interestPointsRewardsProgram" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="introductoryRate" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="balanceConsolidationRate" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="riskRate" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="riskRateClassificationMinimum" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="riskRateClassificationMaximum" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="interestRateDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="interestRateCriteria" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="minimumBalance" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="maximumBalance" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="term" type="xs:duration" minOccurs="0" maxOccurs="1"/>
<xs:element name="effectiveDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="expirationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="interestRate" type="xs:decimal" minOccurs="0" maxOccurs="1"/>
<xs:element name="annualPercentageRate" type="common:AnnualPercentageRate" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: InterestRateList

Name InterestRateList
Abstract no
Documentation The interest rate list collection/array contains all the possible interest rates for a product offering. This can be used for tiered pricing, risk pricing or effective date pricing.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"interestRate" : InterestRate , [0..*] ?
}
Schema Component Representation
<xs:complexType name="InterestRateList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="interestRate" type="InterestRate" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ProductIdList

Name ProductIdList
Abstract no
Documentation Product sub type filter for making a request. If the list is nil then that indicates that no filters should be applied for product sub type.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productId" : ProductId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ProductIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="productId" type="ProductId" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ProductOffering

Name ProductOffering
Abstract no
JSON Instance Representation
{
"productId" : ProductId , [0..1] ?
"productType" : account:AccountType , [0..1] ?
"productSubType" : ProductSubType , [0..1] ?
"systemProductKeys" : common:CustomData , [0..1] ?
"description" : xs:string , [0..1] ?
"pointsRewardsProgram" : xs:boolean , [0..1] ?
"interestRateList" : InterestRateList , [0..1] ?
"brand" : xs:string , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ProductOffering">
<xs:sequence>
<xs:element name="productId" type="ProductId" minOccurs="0" maxOccurs="1"/>
<xs:element name="productType" type="account:AccountType" minOccurs="0" maxOccurs="1"/>
<xs:element name="productSubType" type="ProductSubType" minOccurs="0" maxOccurs="1"/>
<xs:element name="systemProductKeys" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="pointsRewardsProgram" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="interestRateList" type="InterestRateList" minOccurs="0" maxOccurs="1"/>
<xs:element name="brand" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ProductOfferingList

Name ProductOfferingList
Abstract no
Documentation The product offering collection/array contains all the possible product types for an instance that the credential set is authorized to access at the institution based on applied filters.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productOffering" : ProductOffering , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ProductOfferingList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="productOffering" type="ProductOffering" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ProductSubTypeList

Name ProductSubTypeList
Abstract no
Documentation Product sub type filter used for making a request. If the list is nil then that indicates that no filters should be applied for product sub type.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productSubType" : ProductSubType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ProductSubTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="productSubType" type="ProductSubType" minOccurs="0" maxOccurs="unbounded" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: ProductTypeList

Name ProductTypeList
Abstract no
Documentation Product type filter for making a request. If the list is nil then that indicates that no filters should be applied for product type.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"productType" : account:AccountType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="ProductTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="productType" type="account:AccountType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: ProductId

Name ProductId
Content
  • Base XSD Type: string
Documentation Product ID is a unique identifier for the product.
Schema Component Representation
<xs:simpleType name="ProductId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: ProductSubType

Name ProductSubType
Content
  • Base XSD Type: string
Documentation Product sub type identifies how the product will be identified in the back end system.
Schema Component Representation
<xs:simpleType name="ProductSubType">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top