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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/Transaction.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/Artifact.xsd (at Artifact.xsd)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/Transaction.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
artifact http://cufxstandards.com/v4/Artifact.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v4/Transaction.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/Artifact.xsd" schemaLocation="Artifact.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: transactionList

Name transactionList
Type TransactionList
Nillable no
Abstract no
Documentation The transaction collection/array contains all the transactions for the given account.
JSON Instance Representation
{transactionList
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"transaction" : Transaction , [0..*]
transactionList}
Schema Component Representation
<xs:element name="transactionList" type="TransactionList"/>
top

Global Definitions

Complex Type: CheckNumberList

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

Complex Type: Transaction

Name Transaction
Abstract no
Documentation If there is a start date where provided or required, the transactions collection/array should remain empty if no transactions were posted during the provided date period. In this case, the data provider should still return all other account information.
JSON Instance Representation
{
"transactionId" : TransactionId , [0..1] ?
"accountId" : account:AccountId , [0..1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"type" : TransactionType , [0..1] ?
"amount" : common:Money , [0..1] ?
"description" : xs:string , [0..1] ?
"checkNumber" : common:CheckNumber , [0..1] ?
"dateTimePosted" : xs:dateTime , [0..1] ?
"dateTimeEffective" : xs:dateTime , [0..1] ?
"status" : TransactionStatus , [0..1] ?
"otherTransactionStatus" : xs:string , [0..1] ?
"postedActualBalance" : common:Money , [0..1] ?
"postedAvailableBalance" : common:Money , [0..1] ?
"principalAmount" : common:Money , [0..1] ?
"interestAmount" : common:Money , [0..1] ?
"transactionFeeList" : TransactionFeeList , [0..1] ?
"merchantCategoryCode" : xs:string , [0..1] ?
"category" : TransactionCategory , [0..1] ?
"source" : TransactionSource , [0..1] ?
"escrowAmount" : common:Money , [0..1] ?
"transactionArtifactId" : artifact:ArtifactId , [0..1] ?
"transactionArtifactUri" : artifact:ArtifactUri , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"noteIdList" : common:NoteIdList , [0..1] ?
"entryMethod" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Transaction">
<xs:sequence>
<xs:element name="transactionId" type="TransactionId" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountId" type="account:AccountId" minOccurs="0" 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:element name="type" type="TransactionType" minOccurs="0" maxOccurs="1"/>
<xs:element name="amount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="checkNumber" type="common:CheckNumber" minOccurs="0" maxOccurs="1"/>
<xs:element name="dateTimePosted" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="dateTimeEffective" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="status" type="TransactionStatus" minOccurs="0" maxOccurs="1" default="Posted"/>
<xs:element name="otherTransactionStatus" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="postedActualBalance" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="postedAvailableBalance" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="principalAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="interestAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="transactionFeeList" type="TransactionFeeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="merchantCategoryCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="category" type="TransactionCategory" minOccurs="0" maxOccurs="1"/>
<xs:element name="source" type="TransactionSource" minOccurs="0" maxOccurs="1"/>
<xs:element name="escrowAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="transactionArtifactId" type="artifact:ArtifactId" minOccurs="0" maxOccurs="1"/>
<xs:element name="transactionArtifactUri" type="artifact:ArtifactUri" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="noteIdList" type="common:NoteIdList" minOccurs="0" maxOccurs="1"/>
<xs:element name="entryMethod" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TransactionCategoryList

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

Complex Type: TransactionFee

Name TransactionFee
Abstract no
Documentation Details related to transaction fees.
JSON Instance Representation
{
"transactionFeeId" : xs:string , [0..1] ?
"transactionFeeDateTimePosted" : xs:dateTime , [0..1] ?
"transactionfeeAmount" : common:Money , [0..1] ?
"transactionFeeCode" : xs:string , [0..1] ?
"transactionFeeDescription" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="TransactionFee">
<xs:sequence>
<xs:sequence>
<xs:element name="transactionFeeId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="transactionFeeDateTimePosted" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="transactionfeeAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="transactionFeeCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="transactionFeeDescription" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:sequence>
</xs:complexType>
top

Complex Type: TransactionFeeList

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

Complex Type: TransactionIdList

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

Complex Type: TransactionList

Name TransactionList
Abstract no
Documentation The transaction collection/array contains all the transactions for the given account.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"transaction" : Transaction , [0..*]
}
Schema Component Representation
<xs:complexType name="TransactionList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="transaction" type="Transaction" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: TransactionSourceList

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

Complex Type: TransactionStatusList

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

Simple Type: TransactionCategory

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

Simple Type: TransactionId

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

Simple Type: TransactionSource

Name TransactionSource
Content
  • Base XSD Type: string
  • value comes from list: {'Ach'|'Adjustment'|'Atm'|'BalanceTransfer'|'BillPay'|'BulkDeposit'|'Cash'|'Check'|'Fee'|'HomeBanking'|'Insurance'|'InterestEarned'|'InterestPaid'|'InterestRefund'|'Ivr'|'Kiosk'|'MobileBanking'|'Other'|'Payroll'|'PinPurchase'|'POS'|'SharedBranch'|'Signature'|'Wire'|'Withholding'}
Documentation System or delivery channel that was the origination source for the transaction.
Schema Component Representation
<xs:simpleType name="TransactionSource">
<xs:restriction base="xs:string">
<xs:enumeration value="Ach"/>
<xs:enumeration value="Adjustment"/>
<xs:enumeration value="Atm"/>
<xs:enumeration value="BalanceTransfer"/>
<xs:enumeration value="BillPay"/>
<xs:enumeration value="BulkDeposit"/>
<xs:enumeration value="Cash"/>
<xs:enumeration value="Check"/>
<xs:enumeration value="Fee"/>
<xs:enumeration value="HomeBanking"/>
<xs:enumeration value="Insurance"/>
<xs:enumeration value="InterestEarned"/>
<xs:enumeration value="InterestPaid"/>
<xs:enumeration value="InterestRefund"/>
<xs:enumeration value="Ivr"/>
<xs:enumeration value="Kiosk"/>
<xs:enumeration value="MobileBanking"/>
<xs:enumeration value="Other"/>
<xs:enumeration value="Payroll"/>
<xs:enumeration value="PinPurchase"/>
<xs:enumeration value="POS"/>
<xs:enumeration value="SharedBranch"/>
<xs:enumeration value="Signature"/>
<xs:enumeration value="Wire"/>
<xs:enumeration value="Withholding"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: TransactionStatus

Name TransactionStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Posted'|'Pending'|'Denied'|'Void'|'Hold'|'Other'}
Documentation An enumeration of possible statuses for a transaction request.
Schema Component Representation
<xs:simpleType name="TransactionStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Posted"/>
<xs:enumeration value="Pending"/>
<xs:enumeration value="Denied"/>
<xs:enumeration value="Void"/>
<xs:enumeration value="Hold"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: TransactionType

Name TransactionType
Content
  • Base XSD Type: string
  • value comes from list: {'Debit'|'Credit'}
Schema Component Representation
<xs:simpleType name="TransactionType">
<xs:restriction base="xs:string">
<xs:enumeration value="Debit"/>
<xs:enumeration value="Credit"/>
</xs:restriction>
</xs:simpleType>
top