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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/Card.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/Party.xsd (at Party.xsd)
    • http://cufxstandards.com/v4/Contact.xsd (at Contact.xsd)
    • http://cufxstandards.com/v4/Common.xsd (at Common.xsd)
    • http://cufxstandards.com/v4/Account.xsd (at Account.xsd)
    • http://cufxstandards.com/v4/Artifact.xsd (at Artifact.xsd)

Declared Namespaces

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

Global Declarations

Element: cardList

Name cardList
Type CardList
Nillable no
Abstract no
Documentation Top level element cards collection/array contains all the cards, for instance, that the credential set is authorized to access at the Institution based on applied filters.
JSON Instance Representation
{cardList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"card" : Card , [0..*]
cardList}
Schema Component Representation
<xs:element name="cardList" type="CardList"/>
top

Global Definitions

Complex Type: Card

Name Card
Abstract no
JSON Instance Representation
{
"cardId" : CardId , [0..1] ?
"cardNumber" : xs:string , [0..1] ?
"cardType" : CardType , [1] ?
"cardSubType" : xs:string , [0..1] ?
"expirationDate" : xs:date , [0..1] ?
"pin" : xs:string , [0..1] ?
"cvv2" : xs:string , [0..1] ?
"linkedAccountList" : LinkedAccountList , [1] ?
"partyId" : party:PartyId , [1] ?
"overrideAddressContactId" : contact:ContactId , [0..1] ?
"cardAddress" : common:Address , [0..1] ?
"nameOnCard" : xs:string , [0..2] ?
"activationDateTime" : xs:dateTime , [0..1] ?
"cardStatus" : CardStatus , [1] ?
"blockedReason" : xs:string , [0..1] ?
"blockedDateTime" : xs:dateTime , [0..1] ?
"cardStatusDateTime" : xs:dateTime , [0..1] ?
"cardStatusReason" : xs:string , [0..1] ?
"virtualNumber" : xs:string , [0..1] ?
"merchantCountryCodes" : MerchantCountryCodeList , [0..1] ?
"cardDesignImageArtifactId" : artifact:ArtifactId , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Card">
<xs:sequence>
<xs:element name="cardId" type="CardId" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardType" type="CardType" minOccurs="1" maxOccurs="1"/>
<xs:element name="cardSubType" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="expirationDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
<xs:element name="pin" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="cvv2" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="linkedAccountList" type="LinkedAccountList" minOccurs="1" maxOccurs="1"/>
<xs:element name="partyId" type="party:PartyId" minOccurs="1" maxOccurs="1"/>
<xs:element name="overrideAddressContactId" type="contact:ContactId" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardAddress" type="common:Address" minOccurs="0" maxOccurs="1"/>
<xs:element name="nameOnCard" type="xs:string" minOccurs="0" maxOccurs="2"/>
<xs:element name="activationDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardStatus" type="CardStatus" minOccurs="1" maxOccurs="1"/>
<xs:element name="blockedReason" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="blockedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardStatusDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardStatusReason" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="virtualNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="merchantCountryCodes" type="MerchantCountryCodeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="cardDesignImageArtifactId" type="artifact:ArtifactId" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: CardIdList

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

Complex Type: CardList

Name CardList
Abstract no
Documentation The cards collection/array contains all the cards, for 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. -->
"card" : Card , [0..*]
}
Schema Component Representation
<xs:complexType name="CardList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="card" type="Card" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: CardStatusList

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

Complex Type: CardTypeList

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

Complex Type: LinkedAccount

Name LinkedAccount
Abstract no
Documentation A deposit or loan account that is accessible by the card.
JSON Instance Representation
{
"accountId" : account:AccountId , [1] ?
"priority" : xs:positiveInteger , [1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
}
Schema Component Representation
<xs:complexType name="LinkedAccount">
<xs:sequence>
<xs:element name="accountId" type="account:AccountId" minOccurs="1" maxOccurs="1"/>
<xs:element name="priority" type="xs:positiveInteger" minOccurs="1" maxOccurs="1"/>
<xs:element name="accountType" type="account:AccountType" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountSubType" type="account:AccountSubType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: LinkedAccountList

Name LinkedAccountList
Abstract no
Documentation A collection of accounts linked to a card that are accessible from an ATM.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"linkedAccount" : LinkedAccount , [1..*]
}
Schema Component Representation
<xs:complexType name="LinkedAccountList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="linkedAccount" type="LinkedAccount" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: MerchantCountryCodeList

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

Simple Type: CardId

Name CardId
Content
  • Base XSD Type: string
Documentation The card ID is a persistent and unique identifier for the card. It must be unique for all users across the institution and remain the same over the life of the card. The card ID should not be the same as the card number embossed on the card.
Schema Component Representation
<xs:simpleType name="CardId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: CardStatus

Name CardStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Active'|'AssignPIN'|'Blocked'|'Closed'|'Expedite'|'Expired'|'HotCarded'|'Inactive'|'Issued'|'Lost'|'ReadOnly'|'Restricted'|'Stolen'|'Suspended'|'Other'}
Documentation Enumeration of the different types of statuses for a card.
Schema Component Representation
<xs:simpleType name="CardStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Active"/>
<xs:enumeration value="AssignPIN"/>
<xs:enumeration value="Blocked"/>
<xs:enumeration value="Closed"/>
<xs:enumeration value="Expedite"/>
<xs:enumeration value="Expired"/>
<xs:enumeration value="HotCarded"/>
<xs:enumeration value="Inactive"/>
<xs:enumeration value="Issued"/>
<xs:enumeration value="Lost"/>
<xs:enumeration value="ReadOnly"/>
<xs:enumeration value="Restricted"/>
<xs:enumeration value="Stolen"/>
<xs:enumeration value="Suspended"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: CardType

Name CardType
Content
  • Base XSD Type: string
  • value comes from list: {'Atm'|'Credit'|'Debit'|'HomeEquity'|'Prepaid'}
Documentation Enumeration of the different types of cards.
Schema Component Representation
<xs:simpleType name="CardType">
<xs:restriction base="xs:string">
<xs:enumeration value="Atm"/>
<xs:enumeration value="Credit"/>
<xs:enumeration value="Debit"/>
<xs:enumeration value="HomeEquity"/>
<xs:enumeration value="Prepaid"/>
</xs:restriction>
</xs:simpleType>
top