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

Table of Contents

top

Schema Document Properties

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

Declared Namespaces

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

Global Declarations

Element: remoteDepositList

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

Global Definitions

Complex Type: ImageValidationResult

Name ImageValidationResult
Abstract no
JSON Instance Representation
{
"issue" : ImageValidationIssue , [0..1] ?
"imageValidationResultOther" : xs:string , [0..1] ?
"fixable" : xs:boolean , [0..1] ?
"confirmable" : xs:boolean , [0..1] ?
"message" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="ImageValidationResult">
<xs:sequence>
<xs:element name="issue" type="ImageValidationIssue" minOccurs="0" maxOccurs="1"/>
<xs:element name="imageValidationResultOther" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="fixable" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="confirmable" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="message" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ImageValidationResultList

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

Complex Type: RemoteDeposit

Name RemoteDeposit
Abstract no
JSON Instance Representation
{
"action" : RemoteDepositAction , [0..1] ?
"remoteDepositId" : RemoteDepositId , [0..1] ?
"clientReferenceId" : xs:string , [0..1] ?
"vendorReferenceId" : xs:string , [0..1] ?
"checkNumber" : common:CheckNumber , [0..1] ?
"routingTransitNumber" : xs:string , [0..1] ?
"micrCheckAccountNumber" : account:MicrAccountNumber , [0..1] ?
"amount" : common:Money , [0..1] ?
"userEnteredAmount" : common:Money , [0..1] ?
"immediatelyAvailableAmount" : common:Money , [0..1] ?
"remoteDepositFeeList" : feeSchedule:FeeList , [0..1] ?
"businessDaysHeld" : xs:positiveInteger , [0..1] ?
"cropped" : xs:boolean , [0..1] ?
"remoteDepositImageList" : RemoteDepositImageList , [0..1] ?
"accountId" : account:AccountId , [1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"status" : RemoteDepositStatus , [0..1] ?
"remoteDepositNoteList" : common:NoteList , [0..1] ?
"submittedDateTime" : xs:dateTime , [0..1] ?
"lastUpdateDateTime" : xs:dateTime , [0..1] ?
"customData" : common:CustomData , [0..1] ?
}
Schema Component Representation
<xs:complexType name="RemoteDeposit">
<xs:sequence>
<xs:element name="action" type="RemoteDepositAction" minOccurs="0" maxOccurs="1"/>
<xs:element name="remoteDepositId" type="RemoteDepositId" minOccurs="0" maxOccurs="1"/>
<xs:element name="clientReferenceId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="vendorReferenceId" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="checkNumber" type="common:CheckNumber" minOccurs="0" maxOccurs="1"/>
<xs:element name="routingTransitNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="micrCheckAccountNumber" type="account:MicrAccountNumber" minOccurs="0" maxOccurs="1"/>
<xs:element name="amount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="userEnteredAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="immediatelyAvailableAmount" type="common:Money" minOccurs="0" maxOccurs="1"/>
<xs:element name="remoteDepositFeeList" type="feeSchedule:FeeList" minOccurs="0" maxOccurs="1"/>
<xs:element name="businessDaysHeld" type="xs:positiveInteger" minOccurs="0" maxOccurs="1"/>
<xs:element name="cropped" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="remoteDepositImageList" type="RemoteDepositImageList" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountId" type="account:AccountId" 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:element name="status" type="RemoteDepositStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="remoteDepositNoteList" type="common:NoteList" minOccurs="0" maxOccurs="1"/>
<xs:element name="submittedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="lastUpdateDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: RemoteDepositActionList

Name RemoteDepositActionList
Abstract no
Documentation The list of actions that may be filtered to identify remote deposits to be 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. -->
"action" : RemoteDepositAction , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RemoteDepositActionList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="action" type="RemoteDepositAction" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RemoteDepositIdList

Name RemoteDepositIdList
Abstract no
Documentation The list of remote deposit IDs 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. -->
"remoteDepositId" : RemoteDepositId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RemoteDepositIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="remoteDepositId" type="RemoteDepositId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RemoteDepositImage

Name RemoteDepositImage
Abstract no
JSON Instance Representation
{
"depositImage" : artifact:Artifact , [0..1] ?
"imageSide" : RemoteDepositImageSide , [0..1] ?
"colorSpace" : xs:string , [0..1] ?
"imageValidationResults" : ImageValidationResultList , [0..1] ?
}
Schema Component Representation
<xs:complexType name="RemoteDepositImage">
<xs:sequence>
<xs:element name="depositImage" type="artifact:Artifact" minOccurs="0" maxOccurs="1"/>
<xs:element name="imageSide" type="RemoteDepositImageSide" minOccurs="0" maxOccurs="1"/>
<xs:element name="colorSpace" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="imageValidationResults" type="ImageValidationResultList" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: RemoteDepositImageList

Name RemoteDepositImageList
Abstract no
Documentation The list of remote deposit images 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. -->
"remoteDepositImage" : RemoteDepositImage , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RemoteDepositImageList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="remoteDepositImage" type="RemoteDepositImage" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RemoteDepositList

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

Complex Type: RemoteDepositStatusList

Name RemoteDepositStatusList
Abstract no
Documentation The list of remote deposit 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. -->
"status" : RemoteDepositStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RemoteDepositStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="status" type="RemoteDepositStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: ImageValidationIssue

Name ImageValidationIssue
Content
  • Base XSD Type: string
  • value comes from list: {'FoldedCorners'|'ExcessSkew'|'TooDark'|'TooLight'|'BelowMinSize'|'AboveMaxSize'|'UndersizedImage'|'OversizedImage'|'SpotNoise'|'DateUsability'|'PayeeUsability'|'SignatureUsability'|'PayorUsability'|'MICRUsability'|'ImageFormat'|'EndorsementUsability'|'AmountMismatch'|'Missing'|'ImageQuality'|'Unknown'|'Other'}
Documentation An enumeration of possible image validation issues.
Schema Component Representation
<xs:simpleType name="ImageValidationIssue">
<xs:restriction base="xs:string">
<xs:enumeration value="FoldedCorners"/>
<xs:enumeration value="ExcessSkew"/>
<xs:enumeration value="TooDark"/>
<xs:enumeration value="TooLight"/>
<xs:enumeration value="BelowMinSize"/>
<xs:enumeration value="AboveMaxSize"/>
<xs:enumeration value="UndersizedImage"/>
<xs:enumeration value="OversizedImage"/>
<xs:enumeration value="SpotNoise"/>
<xs:enumeration value="DateUsability"/>
<xs:enumeration value="PayeeUsability"/>
<xs:enumeration value="SignatureUsability"/>
<xs:enumeration value="PayorUsability"/>
<xs:enumeration value="MICRUsability"/>
<xs:enumeration value="ImageFormat"/>
<xs:enumeration value="EndorsementUsability"/>
<xs:enumeration value="AmountMismatch"/>
<xs:enumeration value="Missing"/>
<xs:enumeration value="ImageQuality"/>
<xs:enumeration value="Unknown"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: RemoteDepositAction

Name RemoteDepositAction
Content
  • Base XSD Type: string
  • value comes from list: {'CreateSession'|'SubmitImage'|'Commit'}
Documentation An enumeration of possible actions
Schema Component Representation
<xs:simpleType name="RemoteDepositAction">
<xs:restriction base="xs:string">
<xs:enumeration value="CreateSession"/>
<xs:enumeration value="SubmitImage"/>
<xs:enumeration value="Commit"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: RemoteDepositId

Name RemoteDepositId
Content
  • Base XSD Type: string
Documentation The RemoteDeposit ID is a persistent and unique identifier for the party not related to the accounts they own but tied to that person or organization. It should be unique for all parties across the institution and remain the same over the life of the relationship with the financial institution.
Schema Component Representation
<xs:simpleType name="RemoteDepositId">
<xs:restriction base="xs:string"/>
</xs:simpleType>
top

Simple Type: RemoteDepositImageSide

Name RemoteDepositImageSide
Content
  • Base XSD Type: string
  • value comes from list: {'Front'|'Back'}
Documentation An enumeration of possible image sides.
Schema Component Representation
<xs:simpleType name="RemoteDepositImageSide">
<xs:restriction base="xs:string">
<xs:enumeration value="Front"/>
<xs:enumeration value="Back"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: RemoteDepositStatus

Name RemoteDepositStatus
Content
  • Base XSD Type: string
  • value comes from list: {'ExceedsDepositLimit'|'Approved'|'UnderReview'|'DeclinedEligibility'|'DeclinedImageValidationIssue'|'DuplicateItem'|'InvalidReferenceId'|'PendingReview'|'Suspended'|'Unknown'|'UnacceptableRisk'|'UnknownUser'|'InvalidAccount'|'ConfirmationRequired'}
Documentation An enumeration of possible statuses for a remote deposit capture request.
Schema Component Representation
<xs:simpleType name="RemoteDepositStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="ExceedsDepositLimit"/>
<xs:enumeration value="Approved"/>
<xs:enumeration value="UnderReview"/>
<xs:enumeration value="DeclinedEligibility"/>
<xs:enumeration value="DeclinedImageValidationIssue"/>
<xs:enumeration value="DuplicateItem"/>
<xs:enumeration value="InvalidReferenceId"/>
<xs:enumeration value="PendingReview"/>
<xs:enumeration value="Suspended"/>
<xs:enumeration value="Unknown"/>
<xs:enumeration value="UnacceptableRisk"/>
<xs:enumeration value="UnknownUser"/>
<xs:enumeration value="InvalidAccount"/>
<xs:enumeration value="ConfirmationRequired"/>
</xs:restriction>
</xs:simpleType>
top