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

Table of Contents

top

Schema Document Properties

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

Declared Namespaces

Prefix Namespace
Default namespace http://cufxstandards.com/v5/BillPayee.xsd
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://cufxstandards.com/v5/Common.xsd
relationship http://cufxstandards.com/v5/Relationship.xsd
contact http://cufxstandards.com/v5/Contact.xsd
account http://cufxstandards.com/v5/Account.xsd
Schema Component Representation
<xs:schema targetNamespace="http://cufxstandards.com/v5/BillPayee.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/Relationship.xsd" schemaLocation="Relationship.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Contact.xsd" schemaLocation="Contact.xsd"/>
<xs:import namespace="http://cufxstandards.com/v5/Account.xsd" schemaLocation="Account.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: billPayeeList

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

Global Definitions

Complex Type: BillPayee

Name BillPayee
Abstract no
JSON Instance Representation
{
"billPayeeId" : BillPayeeId , [0..1] ?
"billPayeeGlobalId" : BillPayeeGlobalId , [0..1] ?
"payeeName" : xs:string , [0..1] ?
"payeeAddress" : contact:ContactAddress , [0..1] ?
"payeePhone" : contact:Phone , [0..1] ?
"payeeEmail" : contact:Email , [0..1] ?
"processorName" : xs:string , [0..1] ?
"payeeACHRoutingNumber" : xs:string , [0..1] ?
"payeeACHAccountNumber" : xs:string , [0..1] ?
"isElectronic" : xs:boolean , [0..1] ?
"isEBillProvider" : xs:boolean , [0..1] ?
"addedDateTime" : xs:dateTime , [0..1] ?
"updatedDateTime" : xs:dateTime , [0..1] ?
"minimumDaysToPay" : xs:int , [1] ?
"partyId" : common:PartyId , [0..1] ?
"relationshipId" : relationship:RelationshipId , [0..1] ?
"accountId" : account:AccountId , [0..1] ?
"accountType" : account:AccountType , [0..1] ?
"accountSubType" : account:AccountSubType , [0..1] ?
"userDefinedName" : xs:string , [0..1] ?
"payeeAccountNumber" : xs:string , [0..1] ?
"accountHolderName" : xs:string , [0..1] ?
"payeeCategory" : xs:string , [0..1] ?
"payeeStatus" : PayeeStatus , [0..1] ?
"defaultPaymentFromAccountId" : account:AccountId , [0..1] ?
"earlyPaymentDateTime" : xs:dateTime , [0..1] ?
"nextPaymentDateTime" : xs:dateTime , [0..1] ?
"isRecurringPaymentEnabled" : xs:boolean , [0..1] ?
"customData" : common:CustomData , [0..1] ?
"eBillEnrollmentStatus" : EBillEnrollmentStatus , [0..1] ?
"otherEBillEnrollmentStatus" : xs:string , [0..1] ?
}
Schema Component Representation
<xs:complexType name="BillPayee">
<xs:sequence>
<xs:element name="billPayeeId" type="BillPayeeId" minOccurs="0" maxOccurs="1"/>
<xs:element name="billPayeeGlobalId" type="BillPayeeGlobalId" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeAddress" type="contact:ContactAddress" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeePhone" type="contact:Phone" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeEmail" type="contact:Email" minOccurs="0" maxOccurs="1"/>
<xs:element name="processorName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeACHRoutingNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeACHAccountNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="isElectronic" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="isEBillProvider" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="addedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="updatedDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="minimumDaysToPay" type="xs:int" minOccurs="1" maxOccurs="1"/>
<xs:element name="partyId" type="common:PartyId" minOccurs="0" maxOccurs="1"/>
<xs:element name="relationshipId" type="relationship:RelationshipId" 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="userDefinedName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeAccountNumber" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="accountHolderName" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeCategory" type="xs:string" minOccurs="0" maxOccurs="1"/>
<xs:element name="payeeStatus" type="PayeeStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="defaultPaymentFromAccountId" type="account:AccountId" minOccurs="0" maxOccurs="1"/>
<xs:element name="earlyPaymentDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="nextPaymentDateTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
<xs:element name="isRecurringPaymentEnabled" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
<xs:element name="customData" type="common:CustomData" minOccurs="0" maxOccurs="1"/>
<xs:element name="eBillEnrollmentStatus" type="EBillEnrollmentStatus" minOccurs="0" maxOccurs="1"/>
<xs:element name="otherEBillEnrollmentStatus" type="xs:string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: BillPayeeGlobalIdList

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

Complex Type: BillPayeeIdList

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

Complex Type: BillPayeeList

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

Complex Type: EBillEnrollmentStatusList

Name EBillEnrollmentStatusList
Abstract no
Documentation The list of ebill enrollment statuses that should have their associated bill payee 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. -->
"eBillEnrollmentStatus" : EBillEnrollmentStatus , [0..*] ?
}
Schema Component Representation
<xs:complexType name="EBillEnrollmentStatusList">
<xs:complexContent>
<xs:extension base="common:ListBase">
<xs:sequence>
<xs:element name="eBillEnrollmentStatus" type="EBillEnrollmentStatus" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: PayeeStatusList

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

Simple Type: BillPayeeGlobalId

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

Simple Type: BillPayeeId

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

Simple Type: EBillEnrollmentStatus

Name EBillEnrollmentStatus
Content
  • Base XSD Type: string
  • value comes from list: {'Ineligible'|'Enrolled'|'NotEnrolled'|'PendingEnrollment'|'PendingUnenrollment'|'Error'|'Other'}
Documentation This is enumeration of statuses for the ebill Enrollment.
Schema Component Representation
<xs:simpleType name="EBillEnrollmentStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Ineligible"/>
<xs:enumeration value="Enrolled"/>
<xs:enumeration value="NotEnrolled"/>
<xs:enumeration value="PendingEnrollment"/>
<xs:enumeration value="PendingUnenrollment"/>
<xs:enumeration value="Error"/>
<xs:enumeration value="Other"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PayeeStatus

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