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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v5/Hold.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/FeeSchedule.xsd (at FeeSchedule.xsd)
    • http://cufxstandards.com/v5/Account.xsd (at Account.xsd)

Declared Namespaces

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

Global Declarations

Element: holdList

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

Global Definitions

Complex Type: Hold

Name Hold
Abstract no
JSON Instance Representation
{
"holdId" : HoldId , [0..1] ?
"accountId" : account:AccountId , [0..1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"transactionId" : xs:string , [0..1] ?
"holdType" : HoldType , [0..1] ?
"effectiveDate" : xs:dateTime , [0..1] ?
"expirationDate" : xs:dateTime , [0..1] ?
"actualReleaseDate" : xs:dateTime , [0..1] ?
"holdStatus" : HoldStatus , [0..1] ?
"description" : xs:string , [0..1] ?
"amount" : common:Money , [0..1] ?
"payee" : xs:string , [0..1] ?
"reason" : HoldReasonType , [0..1] ?
"feeId" : feeSchedule:FeeId , [0..1] ?
"startCheckNumber" : common:CheckNumber , [0..1] ?
"endCheckNumber" : common:CheckNumber , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="Hold">
<xs:sequence>
<xs:element name="holdId" type="HoldId" 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="transactionId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdType" type="HoldType" minOccurs="0" maxOccurs="1"/>
<xs:element name="effectiveDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="expirationDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="actualReleaseDate" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="holdStatus" type="HoldStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="description" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="amount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="payee" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="reason" type="HoldReasonType" minOccurs="0" maxOccurs="1"/>
<xs:element name="feeId" type="feeSchedule:FeeId" minOccurs="0" maxOccurs="1"/>
<xs:element name="startCheckNumber" type="common:CheckNumber" minOccurs="0" maxOccurs="1"/>
<xs:element name="endCheckNumber" type="common:CheckNumber" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: HoldIdList

Name HoldIdList
Abstract no
Documentation The list of hold IDs that should have their associated hold 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. -->
"holdId" : HoldId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="HoldIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="holdId" type="HoldId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: HoldList

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

Complex Type: HoldReasonTypeList

Name HoldReasonTypeList
Abstract no
Documentation The list of hold reason types that should have their associated hold 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. -->
"holdReasonType" : HoldReasonType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="HoldReasonTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="holdReasonType" type="HoldReasonType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: HoldTypeList

Name HoldTypeList
Abstract no
Documentation The list of hold types that should have their associated hold 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. -->
"holdType" : HoldType , [0..*] ?
}
Schema Component Representation
<xs:complexType name="HoldTypeList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="holdType" type="HoldType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: HoldId

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

Simple Type: HoldReasonType

Name HoldReasonType
Content
  • Base XSD Type: string
  • value comes from list: {'Unknown'|'Lost'|'Stolen'|'Destroyed'|'NotEndorsed'|'Certified'|'Disputed'|'ReturnedMerchandise'|'StoppedService'|'Other'}
Schema Component Representation
<xs:simpleType name="HoldReasonType">
<xs:restriction base="xs:string">
<xs:enumeration value="Unknown"/>
<xs:enumeration value="Lost"/>
<xs:enumeration value="Stolen"/>
<xs:enumeration value="Destroyed"/>
<xs:enumeration value="NotEndorsed"/>
<xs:enumeration value="Certified"/>
<xs:enumeration value="Disputed"/>
<xs:enumeration value="ReturnedMerchandise"/>
<xs:enumeration value="StoppedService"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: HoldStatus

Name HoldStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Active'|'InActive'}
Documentation This is the enumeration of statuses for holds.
Schema Component Representation
<xs:simpleType name="HoldStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Active"/>
<xs:enumeration value="InActive"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: HoldType

Name HoldType
Content
  • Base XSD Type: string
  • value comes from list: {'GeneralPurpose'|'CheckHold'|'CertifiedDraft'|'StopDraft'|'SignatureAuth'|'PledgeHold'|'StopACH'|'StopDraftVerbal'|'StopACHVerbal'|'RevokeACH'|'MerchantVerification'|'UncollectedFee'|'HoldDraft'|'BillPayment'|'UnauthorizedACHStop'|'ACHOrigination'|'ACHDNE'|'PinAuth'|'BusinessBlockACHDebit'|'WireHold'|'Disputed'}
Schema Component Representation
<xs:simpleType name="HoldType">
<xs:restriction base="xs:string">
<xs:enumeration value="GeneralPurpose"/>
<xs:enumeration value="CheckHold"/>
<xs:enumeration value="CertifiedDraft"/>
<xs:enumeration value="StopDraft"/>
<xs:enumeration value="SignatureAuth"/>
<xs:enumeration value="PledgeHold"/>
<xs:enumeration value="StopACH"/>
<xs:enumeration value="StopDraftVerbal"/>
<xs:enumeration value="StopACHVerbal"/>
<xs:enumeration value="RevokeACH"/>
<xs:enumeration value="MerchantVerification"/>
<xs:enumeration value="UncollectedFee"/>
<xs:enumeration value="HoldDraft"/>
<xs:enumeration value="BillPayment"/>
<xs:enumeration value="UnauthorizedACHStop"/>
<xs:enumeration value="ACHOrigination"/>
<xs:enumeration value="ACHDNE"/>
<xs:enumeration value="PinAuth"/>
<xs:enumeration value="BusinessBlockACHDebit"/>
<xs:enumeration value="WireHold"/>
<xs:enumeration value="Disputed"/>
</xs:restriction>
</xs:simpleType>
top