Transfer Source Destination Search
Transfer Source Destination Search
Transfer Source Destination Search is a jXchange messaging service designed to provide the consumer with a listing of accounts/shares/loans that are allowed to be transferred between accounts.
Message Flow
Message flow involves the exchange of MType complexes between the Third Party Consumer and the Service Provider.
Primary Request
The Third Party Consumer sends the message XferSrcDestSrchRq_MType containing the required complex SrchMsgRqHdr_CType. The message can also contain the optional elements AccountId_CType, CustId, XferSrcDestType, and Custom_CType.
Primary Response
The Service Provider returns XferSrcDestSrchRs_MType containing the required element SrchMsgRsHdr_CType. The message can also contain the optional elements AccountId_CType, CustId, XferSrcDestType, PersonName_CType, AcctTitle_AType, ProdCode, ProdDesc, XferExclu, and XferSrcDestSrchAray_AType.
Transfer Source Destination Search Behavior
Transfer Source Destination Search provides consumers with a listing of accounts/drafts/loans that may be on the source and/or destination side of a transfer request. The response includes elements that could be of interest to the consumer in establishing the identity of the accounts/drafts/loans in a transfer relationship. This permits a consumer to be proactive with a list of accounts for a same day transfer rather than submitting a transfer request and receiving a fault or warning.
The request requires the submission of the account identification or customer identification even though they are both optional. The account identification takes precedence over the customer identification when both elements are provided in the request.
The request provides a filter for the consumer, Transfer Source Destination Type, XferSrcDestType, to submit either Source, Src, Destination, Dest, or Both, Both. The source type can be the account that is the source of the funds and the destination can be the account that is to receive the funds. The consumer can expect that when the filter is submitted in the request that the response array only returns that designated source/destination.
The Service Provider returns all Transfer Source Destination Types, XferSrcDestType, when this element is absent from the request.
The Service Provider should provide all the accounts/drafts/loans regardless of their relationship in the response to the submitted account identification request if the accounts/drafts/loans are permissible for a same day transfer.
If a Service Provider does not maintain a transfer table, then the provider should return a reasonable response of accounts/drafts/loans. The response includes accounts/drafts/loans that allow a same day transfer without any errors or warnings. However, if this is the case, the consumer either returns the Transfer Exclusive element, XferExclu, as False or not return it as the absent element default value is False.
The elements provided in the response are related to the account identification or customer identification submitted in the request. A request made with the customer identification does not return the Product Code, ProdCode, or the Product Description, ProdDesc, as these elements are specific to the account identification.
The response conveys the transfer type explicitly of the accounts/drafts/loans returned in the response through the required element Transfer Source Destination Type, XferSrcDestType. The accounts/drafts/loans should appear only once in the response in the respective element canonical value. When the account identification is submitted in the request the account identification only appears in the root level response, not in the response array.
The XferSrcDestSrchRq_MType message permits a consumer to submit an array of restrictions to be considered by the Service Provider to exclude qualifying accounts from the response set. The RstrExcType element is a closed enumerated element with the following canonical values:
- Limited Transaction: ~LmtTrn~
- Charged Off: ~ChgdOff~
- Closed: ~Cls~
- Dormant: ~Dormant~
- No Post: ~NoPost~
- Restriction on Transactions: ~RstrTrn~
- Escheat: ~Escheat~
- Frozen: ~Frz~
- No Credits Posting: ~NoCr~
The Service Provider should not return the account identification in the response set if the account identification would be subject to a business service fault in the Transfer Add service for one of the submitted canonical values.
For example, if the account identification is classified as a Source account (<XferSrcDestType>Src</XferSrcDestType>) and the account identification would create a fault in the Transfer Add service due to the dormant state of the account and the consumer submitted the RstrExcType element with a value of ~Dormant~ then the Service Provider would not return the account identification in the response.
The RstrExcType default is none, so the response returns all account identification regardless of any possible Transfer Add faults. The XferSrcDestSrchInfo_CType complex allows a Service Provider to convey to the consumer the possible known restriction(s) that could exist on the account identification thereby creating a fault in the Transfer Add service along with the XferSrcDestType element. The XferSrcDestSrchRs_MType response message echoes back the XferSrcDestSrchRqArray_AType array.
Transfer Source Destination Search Business Case
The consumer is attempting to obtain a listing of accounts/drafts/loans that may be on the source and/or destination side of a transfer request.
The consumer sends the XferSrcDestSrchRq_MType message with the following values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
| AccountId | AcctId | 0002235555550015 |
| AcctType | D | |
| XferSrcDestType | Both |
The Service Provider returns the XferSrcDestSrchRs_MType message with the following values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
| XferSrcDestSrchArray | ||
| XferSrcDestSrchInfo | ||
| AccountId | AcctId | 0002235555550016 |
| AcctType | D | |
| ProdCode | 01 | |
| ProdDesc | Savings | |
| XferSrcDestType | Both | |
| AccountId | AcctId | 000332149785644 |
| AcctType | D | |
| ProdCode | 02 | |
| ProdDesc | Checking | |
| XferSrcDestType | Both | |
| AccountId | AcctId | 000223551212999 |
| AcctType | D | |
| ProdCode | 01 | |
| ProdDesc | Savings | |
| XferSrcDestType | Src |
This is an illustration of the Transfer Source Destination Search Service.
XferSrcDestSrchRq_MType
XferSrcDestSrchRq_MType is a message MType element.
Contains:
- AccountId_CType
- Custom_CType
- IncXtendElemArray_AType
- SrchMsgRqHdr_CType
- SvcPrvdInfo references XferSrcDestSrchRq_EType
- XferSrcDestSrchRqArray_AType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer.
- XferSrcDestType
- Indicates the role of the transfer request as the source or destination. Canonical
values are:
- Both
- Dest
- Src
AccountId_CType
AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType is an array AType element.
Contains:
- IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex CType element. This is a standard request message header.
Contains:
- AuthenUsrCred_CType
- jXchangeHdr_CType
Simple Elements
The following simple elements are contained within this complex.
- AuthenProdCred
- Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
AuthenUsrCred_CType
AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
Simple Elements
The following simple elements are contained within this complex.
- Security
- Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType
jXchangeHdr_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to authenticate with
for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
- BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the environment in which the
institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number assigned to
financial institutions for routing as assigned by the American Bankers Association. Any
leading zeros must be provided for a complete routing and transit number. A
non-financial institution entity should use a mutually agreed upon identification that
must contain at least one non-integer character.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
SvcPrvdInfo
XferSrcDestSrchRq_EType is available only for JHA Consumers.
SvcPrvdInfo references XferSrcDestSrchRq_EType.
Contains:
- JHAConsumer references XferSrcDestSrchRq_JIS_CType.
JHAConsumer
XferSrcDestSrchRq_JIS_CType is a complex CType element.
JHAConsumer references XferSrcDestSrchRq_JIS_CType.
Simple Elements
The simple elements contained within this complex are listed below.
- AvlBalCalcCode
- A code that would convey to the service provider the method to use for the calculation of the available balance.
XferSrcDestSrchRqArray_AType
XferSrcDestSrchRqArray_AType is an array AType element. This is an array of elements that conveys exclusions from the response set.
Contains:
- XferSrcDestSrchRqInfo_CType
XferSrcDestSrchRqInfo_CType
XferSrcDestSrchRqInfo_CType is a complex CType element.
Simple Elements
The simple elements contained within this complex are listed below.
- RstrExcType
- The type of restrictions to be excluded from a response set.
Canonical values are:
- ChgdOff
- Cls
- Dormant
- Escheat
- Frz
- LmtTrn
- NoCr
- NoPost
- RstrTrn
XferSrcDestSrchRs_MType
XferSrcDestSrchRs_MType is a message MType element.
Contains:
- AccountId_CType
- AcctTitle_AType
- Custom_CType
- PersonName_CType
- SrchMsgRsHdr_CType
- XferSrcDestSrchArray_AType
Simple Elements
The simple elements contained within this message are listed below.
- CustId
- The identifier attached to a customer.
- ProdCode
- The code that identifies a product type of account within an application.
- ProdDesc
- Description of the type of account.
- XferExclu
- Determines if the elements returned for the transfer source/destination are exclusive
to the requested account identification or customer identification. Canonical values are:
- false
- true
- XferSrcDestType
- Indicates the role of the transfer request as the source or destination. Canonical
values are:
- Both
- Dest
- Src
AccountId_CType
AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
AcctTitle_AType
AcctTitle_AType is an array AType element. This is an array of account titles used to define the customer and additional names. This element is optional.
Contains:
- AcctTitleInfo_CType
AcctTitleInfo_CType
AcctTitleInfo_CType is a complex CType element.
Simple Elements
Contains:
- AddlName references PersonName_CType
- AddlPhoneArray references PhoneArray_AType
- AddlTIN references TINInfo_CType
The following simple elements are contained within this complex.
- AcctTitle
- The account title including customer name and additional names.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- AddlBirthDt
- The date of birth.
- AddlNameStat
- The additional person status. Canonical values are:
- Act - active
- NotAct - not active
The ComName element is contained by the AddlName complex and replaces the AcctTitle element. The depreciation effective date for AcctTitle is 2012-01-01.
AddlName
PersonName_CType is a complex CType element. It contains name information. This complex is optional.
AddlName references PersonName_CType.
Contains:
- X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
- NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AddlPhoneArray
PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.
AddlPhoneArray references PhoneArray_AType.
Contains:
- PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.
- MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell.
AddlTIN
TINInfo_CType is a complex CType element. This element contains tax information number codes and descriptions. This element is optional.
AddlTIN references TINInfo_CType.
Contains:
- TaxIdOwnerName references PersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BNotIRSDt
- The last IRS notification.
- BNotStat
- The B notice flag.
- CertCode
- The code that represents the certification behavior for a tax ID.
- CertCodeDesc
- The description of the code that represents the certification behavior for a tax ID.
- CertCodeDt
- The certification code date.
- TaxId
- The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
- TaxIdMod
- A tax ID modifier assigned by the SSA to some individuals.
- TINCode
- The code that designates the type of tax identification number.
- TINDesc
- The description of the code that designates the type of tax identification number.
TaxIdOwnerName
PersonName_CType is a complex CType element. It contains name information. This complex is optional.
This element references PersonName_CType.
The TaxIdOwnerName is optional and is only required when the customer level tax ID is different than the account level.
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
- NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PersonName_CType
PersonName_CType is a complex CType element. It contains name information. This complex is optional.
Contains:
- X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
- NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.
Contains:
- jXchangeHdr_CType
- MsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned. Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be larger than MaxRec.
jXchangeHdr_CType
jXchangeHdr_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to authenticate with
for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
- BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the environment in which the
institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number assigned to
financial institutions for routing as assigned by the American Bankers Association. Any
leading zeros must be provided for a complete routing and transit number. A
non-financial institution entity should use a mutually agreed upon identification that
must contain at least one non-integer character.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType
MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.
Contains:
- MsgRec_CType
MsgRec_CType
MsgRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- ErrCat
- The Soap Header Fault error category.
- ErrCode
- The Soap Header Fault error code.
- ErrDesc
- The Soap Header Fault error description.
- ErrElem
- The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
- ErrElemVal
- The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
- ErrLoc
- The Soap Header Fault error location. This is typically the program that generated the error condition.
XferSrcDestSrchArray_AType
XferSrcDestSrchArray_AType is an array AType element. This is an array of elements for transfer sources and/or destinations that is returned in the search service.
Contains:
- XferSrcDestSrchInfo_CType
XferSrcDestSrchInfo_CType
XferSrcDestSrchInfo_CType is a complex CType element.
Contains:
- AccountId_CType
- AcctTitle_AType
- CustomXferSrcSrchRec references Custom_CType
- PersonName_CType
- SvcPrvdInfo references XferSrcDestSrchInfo_EType
- XferSrcDestRstrArray_AType
Simple Elements
The simple elements contained within this complex are listed below.
- CustId
- The identifier attached to a customer.
- ProdCode
- The code that identifies a product type of account within an application.
- ProdDesc
- Description of the type of account.
- XferSrcDestType
- Indicates the role of the transfer request as the source or destination. Canonical
values are:
- Both
- Dest
- Src
AccountId_CType
AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
AcctTitle_AType
AcctTitle_AType is an array AType element. This is an array of account titles used to define the customer and additional names. This element is optional.
Contains:
- AcctTitleInfo_CType
AcctTitleInfo_CType
AcctTitleInfo_CType is a complex CType element.
Simple Elements
Contains:
- AddlName references PersonName_CType
- AddlPhoneArray references PhoneArray_AType
- AddlTIN references TINInfo_CType
The following simple elements are contained within this complex.
- AcctTitle
- The account title including customer name and additional names.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- AddlBirthDt
- The date of birth.
- AddlNameStat
- The additional person status. Canonical values are:
- Act - active
- NotAct - not active
The ComName element is contained by the AddlName complex and replaces the AcctTitle element. The depreciation effective date for AcctTitle is 2012-01-01.
AddlName
PersonName_CType is a complex CType element. It contains name information. This complex is optional.
AddlName references PersonName_CType.
Contains:
- X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
- NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AddlPhoneArray
PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.
AddlPhoneArray references PhoneArray_AType.
Contains:
- PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.
- MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell.
AddlTIN
TINInfo_CType is a complex CType element. This element contains tax information number codes and descriptions. This element is optional.
AddlTIN references TINInfo_CType.
Contains:
- TaxIdOwnerName references PersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BNotIRSDt
- The last IRS notification.
- BNotStat
- The B notice flag.
- CertCode
- The code that represents the certification behavior for a tax ID.
- CertCodeDesc
- The description of the code that represents the certification behavior for a tax ID.
- CertCodeDt
- The certification code date.
- TaxId
- The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
- TaxIdMod
- A tax ID modifier assigned by the SSA to some individuals.
- TINCode
- The code that designates the type of tax identification number.
- TINDesc
- The description of the code that designates the type of tax identification number.
TaxIdOwnerName
PersonName_CType is a complex CType element. It contains name information. This complex is optional.
This element references PersonName_CType.
The TaxIdOwnerName is optional and is only required when the customer level tax ID is different than the account level.
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
- NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
CustomXferSrcSrchRec
Custom_CType is a complex CType element.
CustomXferSrcSrchRec references Custom_CType.
This element is optional.
PersonName_CType
PersonName_CType is a complex CType element. It contains name information. This complex is optional.
Contains:
- X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
- NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SvcPrvdInfo
XferSrcDestSrchInfo_EType is available only for JHA Consumers.
SvcPrvdInfo references XferSrcDestSrchInfo_EType.
Contains:
- JHAConsumer references XferSrcDestSrchInfo_JIS_CType.
JHAConsumer
XferSrcDestSrchInfo_JIS_CType is a complex CType element.
JHAConsumer references XferSrcDestSrchInfo_JIS_CType.
Simple Elements
The simple elements contained within this complex are listed below.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
- AcctRelDesc
- The description of the code that describes the relationship a customer has to an account.
- AcctStat
- The account status.
- AcctStatDesc
- The account status description.
- AvlBal
- The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
- BrCode
- The branch code.
- BrDesc
- A description of the branch name. It includes the Rstr attribute.
- CurBal
- The current balance.
- CurPayOff
- The current payoff amount.
- LmtTrnXsCnt
- The number of items that currently posted to an account that can be classified as a limited transaction.
- LmtTrnXsTolr
- An accounts limited transaction tolerance value for transactional activity.
- MatDt
- The maturity date.
- NxtPayDt
- The next payment date.
- PlnCode
- The service provider code that represents plan products for different plan types.
- PlnDesc
- The description of service provider code that represents plan products for different plan types.
- PmtAmt
- The payment amount.
- PmtAmtDue
- The payment amount due.
XferSrcDestRstrArray_AType
XferSrcDestRstrArray_AType is an array AType element. This is an array of elements that indicates the restrictions that could exist on the transfer account.
Contains:
- XferSrcDestRstrInfo_CType
XferSrcDestRstrInfo_CType
XferSrcDestRstrInfo_CType is a complex CType element.
Simple Elements
The simple elements contained within this complex are listed below.
- RstrExcType
- The type of restrictions to be excluded from a response set.
Canonical values are:
- ChgdOff
- Cls
- Dormant
- Escheat
- Frz
- LmtTrn
- NoCr
- NoPost
- RstrTrn
- XferSrcDestType
- Indicates the role of the transfer request as the source or destination. Canonical
values are:
- Both
- Dest
- Src
XferSrcDestSrchRqArray_AType
XferSrcDestSrchRqArray_AType is an array AType element. This is an array of elements that conveys exclusions from the response set.
Contains:
- XferSrcDestSrchRqInfo_CType
XferSrcDestSrchRqInfo_CType
XferSrcDestSrchRqInfo_CType is a complex CType element.
Simple Elements
The simple elements contained within this complex are listed below.
- RstrExcType
- The type of restrictions to be excluded from a response set.
Canonical values are:
- ChgdOff
- Cls
- Dormant
- Escheat
- Frz
- LmtTrn
- NoCr
- NoPost
- RstrTrn