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

Table of Contents

top

Schema Document Properties

Target Namespace http://cufxstandards.com/v4/FundsTransferCommonBase.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)

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v4/FundsTransferCommonBase.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v4/Common.xsd
Schema Component Representation
<xs:schema id="FundsTransferCommonBase" targetNamespace="http://cufxstandards.com/v4/FundsTransferCommonBase.xsd" version="4.5.$Revision$" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://cufxstandards.com/v4/Common.xsd" schemaLocation="Common.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: recurringId

Name recurringId
Type RecurringId
Nillable no
Abstract no
Documentation ID to uniquely identify a recurring payment or transfer request.
JSON Instance Representation
"recurringId" : RecurringId ,
Schema Component Representation
<xs:element name="recurringId" type="RecurringId"/>
top

Global Definitions

Complex Type: BatchIdList

Name BatchIdList
Abstract no
Documentation The list of batch ids that should have their associated payments or transfers 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. -->
"batchId" : BatchId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="BatchIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="batchId" type="BatchId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: OccurrenceIdList

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

Complex Type: OccurrenceStatusList

Name OccurrenceStatusList
Abstract no
Documentation The list of payments or transfers occurrence status's that should have their associated occurrence status 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. -->
"occurrenceStatus" : OccurrenceStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="OccurrenceStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="occurrenceStatus" type="OccurrenceStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RecurringIdList

Name RecurringIdList
Abstract no
Documentation The list of recurring payments or transfer requests.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"recurringId" : RecurringId , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RecurringIdList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="recurringId" type="RecurringId" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: RecurringStatusList

Name RecurringStatusList
Abstract no
Documentation The list of recurring status for payments or transfer requests for filtering.
JSON Instance Representation
{
<!-- 'common:ListBase' super type was not found in this schema. Some elements and attributes may be missing. -->
"recurringStatus" : RecurringStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="RecurringStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="recurringStatus" type="RecurringStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: BatchId

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

Simple Type: FundsWithdrawalType

Name FundsWithdrawalType
Content
  • Base XSD Type: string
  • value comes from list: {'WhenRequested'|'WhenCleared'}
Documentation This is the enumeration of statuses for a recurring payment or transfer request .
Schema Component Representation
<xs:simpleType name="FundsWithdrawalType">
<xs:restriction base="xs:string">
<xs:enumeration value="WhenRequested"/>
<xs:enumeration value="WhenCleared"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: OccurrenceId

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

Simple Type: OccurrenceStatus

Name OccurrenceStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Scheduled'|'InProcess'|'CancelRequestedByParty'|'CancelRequestedByFinancialInstitution'|'CancelRequestedByProcessor'|'Cancelled'|'Sent'|'Completed'|'Declined'|'FundsOutbound'|'FundsCleared'|'Held'|'InsufficientFunds'|'Returned'|'Suspended'}
Documentation This is the enumeration of statuses for payments or transfers.
Schema Component Representation
<xs:simpleType name="OccurrenceStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Scheduled"/>
<xs:enumeration value="InProcess"/>
<xs:enumeration value="CancelRequestedByParty"/>
<xs:enumeration value="CancelRequestedByFinancialInstitution"/>
<xs:enumeration value="CancelRequestedByProcessor"/>
<xs:enumeration value="Cancelled"/>
<xs:enumeration value="Sent"/>
<xs:enumeration value="Completed"/>
<xs:enumeration value="Declined"/>
<xs:enumeration value="FundsOutbound"/>
<xs:enumeration value="FundsCleared"/>
<xs:enumeration value="Held"/>
<xs:enumeration value="InsufficientFunds"/>
<xs:enumeration value="Returned"/>
<xs:enumeration value="Suspended"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: RecurringId

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

Simple Type: RecurringStatus

Name RecurringStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Requested'|'Active'|'CancelRequestedByParty'|'CancelRequestedByFinancialInstitution'|'CancelRequestedByPaymentProvider'|'Cancelled'|'Completed'|'Suspended'}
Documentation This is the enumeration of statuses for a recurring payment or transfer request .
Schema Component Representation
<xs:simpleType name="RecurringStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Requested"/>
<xs:enumeration value="Active"/>
<xs:enumeration value="CancelRequestedByParty"/>
<xs:enumeration value="CancelRequestedByFinancialInstitution"/>
<xs:enumeration value="CancelRequestedByPaymentProvider"/>
<xs:enumeration value="Cancelled"/>
<xs:enumeration value="Completed"/>
<xs:enumeration value="Suspended"/>
</xs:restriction>
</xs:simpleType>
top