Developer Programs

Learn

Docs
Important notification about upcoming changes to the DMZ environment. Please read.

Internet Financial Institution Id Inquiry

Enterprise SOAP API > API by Reference > Core Services > Internet Financial Institution Id Inquiry

Internet Financial Institution Id Inquiry

Internet Financial Institution Id Inquiry is a jXchange service designed to provide the third-party consumer with the ability to inquire on the behavioral elements as related to an internet banking application.

Message Flow

In jXchange, the Internet Financial Institution Id Inquiry service uses a typical exchange of MType messages to allow users to query behavioral elements related to internet banking applications.

Primary Request

The third-party consumer forwards the IntnetFinInstIdInqRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntent
  • IntnetFinInstId

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

The message contains the following array:

  • IncXtendElemArray_AType

Primary Response

The service provider returns the IntnetFinInstIdInqRs_MType message to the third-party consumer.

The message contains the following simple elements:

  • ActIntent
  • ActIntentKey
  • IntnetFinInstId

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • x_BilPayInfoRec_CType
  • x_IntnetAccessInfoRec_CType
  • x_IntnetCashMgmtInfoRec_CType
  • x_IntnetInfoRec_CType
  • x_IntnetValidXferInfoRec_CType
  • x_IntnetXferInfoRec_CType

The message contains the following extended element:

  • SvcPrvdInfo references IntnetFinInstIdInqRs_EType

Internet Financial Institution Id Inquiry Behavior

Internet Financial Institution Id Inquiry is a jXchange service designed to allow queries on behavioral elements related to internet banking applications.

The IntnetFinInstId element is required in the request message. The IncXtendElemArray_AType array is optional. The IncXtendElem complex contains:

  • x_IntnetInfoRec_CType = Internet Information Record
  • x_IntnetXferInfoRec_CType = Internet Transfer Information Record
  • x_IntnetAccessInfoRec_CType = Internet Access Information Record
  • x_IntnetValidXferInfoRec_CType = Internet Valid Transfer Information Record
  • x_IntnetCashMgmtInfoRec_CType = Internet Cash Management Information Record

The IntnetInfoRec_CType contains the DspAppInfoArray_AType, which provides the third-party consumer with the applications that can appear in a financial institution internet application and the EmailArray_AType for electronic contact information.

The IntnetXferInfoRec_CType contains the XferFromArray_AType, which provides the third-party consumer with the application types permitted for transfer requests. The array element values are only required when the XferTypeLvl element is of the canonical value AcctId.

The IntnetAccessInfoRec_CType contains the RelCodeAccessArray_AType, which provides the third-party consumer with the account relationship codes that are used for allowable account identification access. The array element values are only required when the AcctIdAccess element is of the canonical values RelCustId or RelAcctId.

The IntnetAccessInfoRec_CType complex contains the AcctIdAccessArray_AType, which provides the third-party consumer with the specific accounts identifications for an internet banking application along with each account identification's behavioral elements as related to internet banking.

The IntnetValidXferInfoRec_CType complex contains the ValXferInfoArray_AType, which provides the third-party consumer with account identifications approved for funds transfer activity and some related elements. The IntnetCashMgmtInfoRec_CType complex contains the behavioral elements related to an internet banking cash management application. The CashMgmtAcctInfoArray_AType array is included to convey to the third-party consumer the individual account identification as part of a cash management application and their respective behavioral elements.

IntnetFinInstIdInqRq_MType

IntnetFinInstIdInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElemArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

IntnetFinInstId
The identification assigned to a consumer for the financial institution internet product.

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.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request 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.

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 canonical value is JHA.

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
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.

IntnetFinInstIdInqRs_MType

IntnetFinInstIdInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • SvcPrvdInfo references IntnetFinInstIdInqRs_EType
  • x_BilPayInfoRec_CType
  • x_IntnetAccessInfoRec_CType
  • x_IntnetCashMgmtInfoRec_CType
  • x_IntnetInfoRec_CType
  • x_IntnetValidXferInfoRec_CType
  • x_IntnetXferInfoRec_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
IntnetFinInstId
The identification assigned to a consumer for the financial institution internet product.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

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 canonical value is JHA.

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
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.

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 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.

x_BilPayInfoRec_CType

x_BilPayInfoRec_CType is a complex CType element.

Contains:

  • BilPayInfoArray_AType
  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

BilPayCrCompDesc
The description of the code that indicates what the credit company used for the bill pay processes.

BilPayInfoArray_AType

BilPayInfoArray_AType is an array AType element. This is an array of accounts that participate in internet banking bill pay.

Contains:

  • BilPayInfo_CType
BilPayInfo_CType

BilPayInfo_CType is a complex CType element.

Contains:

  • BilPayInfoRec_CType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

BilPayCrCompDesc
The description of the code that indicates what the credit company used for the bill pay processes.
BilPayInfoRec_CType

BilPayInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AliasAcctName
An alias name provided to an account that is often used for GUI representation that is understandable to an end consumer.
BilPayCrCompCode
The code that indicates what the credit company used for the bill pay processes.
DrAcctId
The debit account number.
DrAcctType
The debit account type.
SerChgWav
The field that defines when an institution debits the account for service charges. Canonical values are:
  • Chg
  • NA
  • Wav
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_IntnetAccessInfoRec_CType

x_IntnetAccessInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • IntnetAccessInfoRec_CType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IntnetAccessInfoRec_CType

IntnetAccessInfoRec_CType is a complex CType element.

Contains:

  • AcctIdAccessArray_AType
  • RelCodeAccessArray_AType
Simple Elements

The following simple elements are contained within this complex.

AcctIdAccess
The account identification relationship types that can be accessed for the internet application. Canonical values are:
  • All
  • RelAcctId
  • RelCustId
AcctIdAccessArray_AType

AcctIdAccessArray_AType is an array AType element. This is an array of account identifications with access permission.

Contains:

  • AcctIdAccessInfo_CType
AcctIdAccessInfo_CType

AcctIdAccessInfo_CType is a complex CType element.

Contains:

  • AccountId_CType
Simple Elements

The following simple elements are contained within this complex.

AccessAlw
Answers the question: Does the enrolled internet user have permission to access the specific account identification in the internet banking application? Canonical values are:
  • true
  • false
AcctElecDocType
Answers the question: Should the account receive electronic documents? Canonical values are:
  • false
  • true
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.
ACHCrPostAmt
The total credit ACH amount of transactions on a given business day.
ACHDrPostAmt
The total debit ACH amount of transactions on a given business day.
AliasAcctName
An alias name provided to an account that is often used for GUI representation that is understandable to an end consumer.
CkCrPostAmt
The amount of check credit posted for a cycle.
CkDrPostAmt
The amount of check debit posted for a cycle.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
FeeChgStmtType
Answers the question: Should internet banking assessed fees be charged at statement time? Canonical values are:
  • false
  • true
LnPmtAlw
The type of loan payments permitted for the enrolled internet user. Canonical values are:
  • IntPmt
  • PrinIntPmt
  • PrinPmt
OTCCrPostAmt
The amount of over the counter credit posted for a cycle.
OTCDrPostAmt
The amount of over the counter debit posted for a cycle.
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.
ProdCode

The code that identifies a product type of account within an application. Canonical values are:

  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

ProdDesc
Description of the type of account.
Rmk
Application or user remarks free-form text.
StmtRetrvAnlysId
The analysis identification given to the statement retrievals to determine fee behavioral assessment.
StmtRetrvFeeAmt
The fixed fee amount charged for the statement retrievals assessment.
StopPmtAddAnlysId
The analysis identification given to the stop payment addition fee to determine the fee behavioral assessment.
StopPmtAddFeeAmt
The fixed fee amount charged for the stop payment additions assessment.
WireCrPostAmt
The amount of wire credit posted for a cycle.
WireDrPostAmt
The amount of wire debit posted for a cycle.
XferCrPostAmt
The amount of transfer credit posted for a cycle.
XferDrPostAmt
The amount of transfer debit posted for a cycle.
XferFromAnlysId
The analysis identification given to the transfer from an account to determine the fee behavioral assessment.
XferFromFeeAmt
The fixed fee amount charged for the transfer from an account assessment.
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
RelCodeAccessArray_AType

RelCodeAccessArray_AType is an array AType element. This is an array of account relationships that would be considered as part of the internet banking application.

Contains:

  • RelCodeAccessInfo_CType
RelCodeAccessInfo_CType

RelCodeAccessInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

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.

x_IntnetCashMgmtInfoRec_CType

x_IntnetCashMgmtInfoRec_CType is a complex CType element.

Contains:

  • CashMgmtUserInfoArray_AType
  • Custom_CType
  • IntnetCashMgmtInfoRec_CType

CashMgmtUsrInfoArray_AType

CashMgmtUsrInfoArray_AType is an array AType element. This is an array of cash management users. It provides all of the cash management user identifications and their single sign on identifications that are attached to a specific internet identification account.

Contains:

  • CashMgmtUsrInfo_CType
CashMgmtUsrInfo_CType

CashMgmtUsrInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CashMgmtUsrId
The user identification of cash management users for a specific internet financial institution enrolled client.
CashMgmtUsrSSOId
The Cash Management user identification single sign-on identification.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IntnetCashMgmtInfoRec_CType

IntnetCashMgmtInfoRec_CType is a complex CType element.

Contains:

  • ACHChgAcctId references AccountId_CType
  • CashMgmtAcctInfoArray_AType
  • FeeChgAcctId references AccountId_CType
  • WireOrignName references PersonName_CType
Simple Elements

The following simple elements are contained within this complex.

ACHBatchAlw
Answers the question: Does the enrolled internet user have permission to submit ACH batch files in the internet banking application? Canonical values are:
  • false
  • true
ACHBatchAnlysId
The analysis identification given to the ACH batches to determine fee behavioral assessment.
ACHBatchFeeAmt
The fixed fee amount charged for ACH batches assessment.
ACHChgStmtType
Answers the question: Should internet banking assessed ACH fees be charged at statement time? Canonical values are:
  • false
  • true
ACHCompName
The ACH company name, as governed by Nacha® rules.
ACHExtrAnlysId
The analysis identification given to the ACH extractions to determine fee behavioral assessment.
ACHExtrFeeAmt
The fixed fee amount charged for ACH extractions assessment.
ACHItemAnlysId
The analysis identification given to the ACH items to determine fee behavioral assessment.
ACHItemFeeAmt
The fixed fee amount charged for ACH items assessment.
BAIRecipId
The Banking Administration Institute (BAI) recipient's identification.
BAIRecipSecId
The secondary Banking Administration Institute (BAI) recipient's identification.
ExtcCurDayBalData
Answers the question: Can the internet banking user be allowed to extract current day balances? Canonical values are:
  • false
  • true
ExtcFileName
The extraction file name.
ExtcFileName
The extraction file name.
ExtcFileType
The extraction file type. Canonical values are:
  • ASCII
  • BAI
  • Prt
  • QIF
  • Text
ExtcFileType
The extraction file type. Canonical values are:
  • ASCII
  • BAI
  • Prt
  • QIF
  • Text
ExtcPriorDayBalData
Answers the question: Can the internet banking user be allowed to extract prior day balances? Canonical values are:
  • false
  • true
ExtcPriorDayBalData
Answers the question: Can the internet banking user be allowed to extract prior day balances? Canonical values are:
  • false
  • true
ExtcPriorDayTrnData
Answers the question: Can the internet banking user be allowed to extract prior day transactional activity? Canonical values are:
  • false
  • true
IntnetMonthChgFreq
Answers the question: What is the frequency to assess the monthly internet banking charge? Canonical values are:
  • BegofMonth
  • EndofMonth
  • Stmt
IntnetMonthFeeAmt
The fixed fee amount charged for the monthly internet assessment.
IntPmtAlw

Is an interest payment allowed?

  • true
  • false
PrinPmtAlw

Is a principal payment allowed? Canonical values are:

  • true
  • false
StmtSerChg
The statement service charge.
WireActAlw
Answers the question: Does the enrolled internet user have permission to wire activity in the internet banking application? Canonical values are:
  • false
  • true
WireRepTrnEntryAlw
Is repetitive wire transaction entry allowable?
WireTrnEntryAlw
Is wire transaction entry allowable?
ACHChgAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

ACHChgAcctId references AccountId_CType.

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
CashMgmtAcctInfoArray_AType

CashMgmtAcctInfoArray_AType is an array AType element. This is an array of accounts that would be considered as part of the cash management internet banking application.

Contains:

  • CashMgmtAcctInfo_CType
CashMgmtAcctInfo_CType

CashMgmtAcctInfo_CType is a complex CType element.

Contains:

  • AccountId_CType
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.
CrtPrtExtcType
Answers the question: Should internet banking application create printed extractions? Canonical values are:
  • false
  • true
CurDayTrnAlw
Answers the question: Does the enrolled internet user have permission to access current day transactions in the internet banking application? Canonical values are:
  • false
  • true
CurDayTrnAnlysId
The analysis identification given to the current day transaction extractions to determine fee behavioral assessment.
CurDayTrnFeeAmt
The fixed fee amount charged for current day transaction extractions assessment.
ExtcAlw
Answers the question: Does the enrolled internet user have permission to extract data in the internet banking application? Canonical values are:
  • false
  • true
ExtcAnlysId
The analysis identification given to the extracted data to determine fee behavioral assessment.
ExtcFeeAmt
The fixed fee amount charged for the extracted data assessment.
ImportAcctReconAnlysId
The analysis identification given to the import of account reconciliation data to determine the fee behavioral assessment.
ImportAcctReconData
Answers the question: Should account reconciliation data be imported to the internet banking user? Canonical values are:
  • false
  • true
ImportAcctReconFeeAmt
The fixed fee amount charged for the import of the account reconciliation data assessment.
ImportAcctReconPlnAnlysId
The analysis identification given to the import of account reconciliation plan data to determine the fee behavioral assessment.
ImportAcctReconPlnData
Answers the question: Should account reconciliation plan data be imported to the internet banking user? Canonical values are:
  • false
  • true
ImportAcctReconPlnFeeAmt
The fixed fee amount charged for the import of the account reconciliation plan data assessment.
ImportPosPayAnlysId
The analysis identification given to the import of positive pay data to determine the fee behavioral assessment.
ImportPosPayData
Answers the question: Should positive pay data be imported to the internet banking user? Canonical values are:
  • false
  • true
ImportPosPayFeeAmt
The fixed fee amount charged for the import of the positive pay data assessment.
IncCombStmt
Include on combined statement. Indicates if this account is to be included in combined statement information. Canonical values are:
  • false
  • true
IntPmtAlw

Is an interest payment allowed?

  • true
  • false
LnPmtAlw
The type of loan payments permitted for the enrolled internet user. Canonical values are:
  • IntPmt
  • PrinIntPmt
  • PrinPmt
PrinPmtAlw

Is a principal payment allowed? Canonical values are:

  • true
  • false
PriorDayTrnAlw
Answers the question: Does the enrolled internet user have permission to access prior day transactions in the internet banking application? Canonical values are:
  • false
  • true
PriorDayTrnAnlysId
The analysis identification given to the prior day transaction extractions to determine fee behavioral assessment.
PriorDayTrnFeeAmt
The fixed fee amount charged for prior day transaction extractions assessment.
StmtRetrvAlw
Answers the question: Does the enrolled internet user have permission to access statement retrieval in the internet banking application? Canonical values are:
  • false
  • true
StmtRetrvAnlysId
The analysis identification given to the statement retrievals to determine fee behavioral assessment.
StmtRetrvFeeAmt
The fixed fee amount charged for the statement retrievals assessment.
StmtSerChg
The statement service charge.
StopPmtAddAlw
Answers the question: Does the enrolled internet user have permission to add stop payments? Canonical values are:
  • false
  • true
StopPmtAddAnlysId
The analysis identification given to the stop payment addition fee to determine the fee behavioral assessment.
StopPmtAddFeeAmt
The fixed fee amount charged for the stop payment additions assessment.
StopPmtInqAlw
Answers the question: Does the enrolled internet user have permission to inquire on stop payments? Canonical values are:
  • false
  • true
StopPmtInqAnlysId
The analysis identification given to the stop payment inquiry extractions to determine fee behavioral assessment.
StopPmtInqFeeAmt
The fixed fee amount charged for stop payment inquiry extractions assessment.
TrnHistAlw
Answers the question: Does the enrolled internet user have permission to access current day transactions in the internet banking application? Canonical values are:
  • false
  • true
TrnHistAnlysId
The analysis identification given to the current day transaction extractions to determine fee behavioral assessment.
TrnHistFeeAmt
The fixed fee amount charged for current day transaction extractions assessment.
WireRepTrnEntryAlw
Is repetitive wire transaction entry allowable?
WireTrnEntryAlw
Is wire transaction entry allowable?
XferAlw
Answers the question: Is the enrolled internet user allowed to transfer funds? Canonical values are:
  • false
  • true
XferAnlysId
The analysis identification given to the transfer service to determine fee behavioral assessment.
XferBalType
Answers the question: What balances should be considered for transfer requests? Canonical values are:
  • Avl
  • Col
  • Ldgr
XferFeeAmt
The fixed fee amount charged for the transfer services assessment.
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
FeeChgAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

FeeChgAcctId references AccountId_CType.

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
WireOrignName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

WireOrignName 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.

AbbName
An abbreviated individual's or entity's name.
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.

x_IntnetInfoRec_CType

x_IntnetInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • IntnetInfoRec_CType

Simple Elements

The following simple elements are contained within this complex.

AcctViewAvlBalDesc
The description of the code that would convey to the service provider the method to use for the calculation of the available balance for account balance displays.
BillPayAvlBalDesc
The description of the code that conveys to the service provider the method to use for the calculation of the available balance for bill payment requests.
BillPayProdDesc
The description of the code assigned to the bill payment product.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
IntnetIdStatDesc
The description of the activity status of the enrolled internet user.
TrnXferAvlBalDesc
The description of the code that would convey to the service provider the method to use for the calculation of the available balance for transaction funds link transfer requests.
XferAvlBalDesc
The description of the code that would convey to the service provider the method to use for the calculation of the available balance for funds transfer requests.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IntnetInfoRec_CType

IntnetInfoRec_CType is a complex CType element.

Contains:

  • ACHFeeChgAcctId references AccountId_CType
  • DspAppInfoArray_AType
  • EmailArray_AType
  • FeeChgAcctId references AccountId_CType
  • IntnetFeeChgArray_AType
  • SvcPrvdInfo references IntnetInfoRec_EType
Simple Elements

The following simple elements are contained within this complex.

AcctViewAvlBalCode
A code that would convey to the service provider the method to use for the calculation of the available balance for account balance displays.
AliasUsrName
The alias name provided to users.
BillPayAlw
Answers the question: Is the enrolled internet user allowed to access bill pay functions? Canonical values are:
  • false
  • true
BillPayAvlBalCode
A code that conveys to the service provider the method to use for the calculation of the available balance for bill payment requests.
BillPayOrigDt
The original date that an internet banking account was set up for bill pay services.
BillPayProdCode
The code assigned to the bill payment product.
BillPayTolrCnt
The number of tolerated bill pay transactions that result in the waiving of bill pay transaction charges.
ClsDspAcctDays
The number of days to continue to display closed accounts.
CrtPswdIdChngLtr
Answers the question: Should a letter be created for an internet user to change their password identification? Canonical values are:
  • false
  • true
EmailNotifType
The type of email notifications sent to the internet user. Canonical values are:
  • AlertOnly
  • All
  • None
  • StmtOnly
EmailRelCust
Answers the question: Should the enrolled internet user's related accounts receive email notifications? Canonical values are:
  • false
  • true
ExtcFldrName
The extraction folder name for file delivery.
FirstAccessDt
The first date an internet banking account was accessed.
IntnetAcptTimeDt
The date and time that a consumer accepted the internet banking agreement.
IntnetCatType

Defines the category related to the internet identifier. Canonical values are:

  • Bus
  • Retail
IntnetFeeChgType

Defines the type of internet identifier fee charge. Canonical values are:

  • ACHItem
  • ACHBatch
IntnetFinInstPswdId
The password used for the financial institution internet product.
Note: The IntnetFinInstPswId is only returned if the service provider creates a password because a password was not provided on the request.
IntnetIdActStat
The activity status of the enrolled internet user. Canonical values are:
  • Active
  • Dormant
IntnetIdState
The state of the internet account. Canonical values are:
  • Active
  • Del
  • Dorm
  • Lock
  • Null

The default is Active.

IntnetIdStat
The activity status of the enrolled internet user.
IntnetMonthAnlysId
The analysis identification given to the monthly internet fee to determine the fee behavioral assessment.
IntnetMonthChgFreq
Answers the question: What is the frequency to assess the monthly internet banking charge? Canonical values are:
  • BegofMonth
  • EndofMonth
  • Stmt
IntnetMonthFeeAmt
The fixed fee amount charged for the monthly internet assessment.
IntnetOrigPIN
The internet banking PIN provided to the consumer when the identification was created.
LastAccessDt
The last date an internet banking account was accessed.
LastAccessTime
The last time an internet banking account was accessed.
LastFailLogInTimeDt
The state of the internet account.
LastMainDt
The last maintenance date.
LnPmtAlw
The type of loan payments permitted for the enrolled internet user. Canonical values are:
  • IntPmt
  • PrinIntPmt
  • PrinPmt
PrevStmtDspAlw
Answers the question: Should the enrolled internet user be allowed to access previous statements? Canonical values are:
  • false
  • true
SecTokenInUse

The state of the internet account. Canonical values are:

  • false
  • true

The default is false.

StmtRtnDays
The number of days previous statements should be retained for viewing.
StopPmtAddAlw
Answers the question: Does the enrolled internet user have permission to add stop payments? Canonical values are:
  • false
  • true
StopPmtInqAlw
Answers the question: Does the enrolled internet user have permission to inquire on stop payments? Canonical values are:
  • false
  • true
TrnXferAvlBalCode
A code that would convey to the service provider the method to use for the calculation of the available balance for transaction funds link transfer requests.
UpdCustEmailType
Describes the methods for updating the customer level email address from the internet email address. Canonical values are:
  • All
  • None
  • PrimEmailAddr
  • SecEmailAddr
WireCompId
The company identification for wire created transactions.
XferAvlBalCode
A code that would convey to the service provider the method to use for the calculation of the available balance for funds transfer requests.
ACHFeeChgAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

ACHFeeChgAcctId references AccountId_CType.

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
DspAppInfoArray_AType

DspAppInfoArray_AType is an array AType element. This is an array of applications that can be displayed for internet applications.

Contains:

  • DspAppInfo_CType
DspAppInfo_CType

DspAppInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DspAppType
The type of applications to appear for an internet banking application. Canonical values are:
  • Club
  • Dep
  • Ln
  • Prot
  • SafeDep
  • Sav
  • TaxPln
  • TimeDep
  • Trck
EmailArray_AType

EmailArray_AType is an array AType element. This is an array used to define email contact information.

Contains:

  • EmailInfo_CType
EmailInfo_CType

EmailInfo_Ctype is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

EmailAddr
Email address.
EmailType
Email type. Examples: Home, Work, Statement, Notice. Canonical values are:
  • Prim
  • Secd
  • OLB

EmailType is a hybrid open enumeration.

FeeChgAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

FeeChgAcctId references AccountId_CType.

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
IntnetFeeChgArray_AType

IntnetFeeChgArray_AType is an array AType element. This array is an array of chargeable fees related to an internet identifier.

Contains:

  • IntnetFeeChgInfo_CType
IntnetFeeChgInfo_CType

IntnetFeeChgInfo_CType is a complex CType element.

Simple Dictionary
AcctAnlysTrnCode
The code that identifies the Account Analysis transaction that determines the counter behavior.
FeeChgAmt
The amount or quantity.
IntnetFeeRecurType

Is the internet fee charge a recurring fee charge? Canonical values are:

  • true
  • false
IntnetFeeChgType

Defines the type of internet identifier fee charge. Canonical values are:

  • ACHItem
  • ACHBatch
Note: AcctAnlysTrnCode and FeeChgAmt are part of a documented choice statement. Both are optional, but at least one is required.
SvcPrvdInfo

IntnetInfoRec_EType is available only for JH Consumers.

SvcPrvdInfo references IntnetInfoRec_EType.

Contains:

  • JHAConsumer references IntnetInfoRec_EType

x_IntnetValidXferInfoRec_CType

x_IntnetValidXferInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • ValidXferInfoArray_AType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ValidXferInfoArray_AType

ValidXferInfoArray_AType is an array AType element. This is an array of accounts approved for transfers from/to activity.

Contains:

  • ValidXferInfo_CType
ValidXferInfo_CType

ValidXferInfo_CType is a complex CType element.

Contains:

  • AccountId_CType
Simple Elements

The following simple elements are contained within this complex.

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.
ProdCode

The code that identifies a product type of account within an application. Canonical values are:

  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

ProdDesc
Description of the type of account.
Rmk
Application or user remarks free-form text.
XferActType
Determines the transfer activity. Canonical values are:
  • false
  • true
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

x_IntnetXferInfoRec_CType

x_IntnetXferInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • IntnetXferInfoRec_CType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IntnetXferInfoRec_CType

IntnetXferInfoRec_CType is a complex CType element.

Contains:

  • XferFromArray_AType
Simple Elements

The following simple elements are contained within this complex.

FutXferDspType
The specific type of transfers permitted for the internet application. Canonical values are:
  • Both
  • FIFutXfer
  • Intnet
  • None
XferAlw
Answers the question: Is the enrolled internet user allowed to transfer funds? Canonical values are:
  • false
  • true
  • LmtCustId
  • ChanSet
XferTypeLvl
Answers the question: Does the enrolled internet user restrict transfer by account or type? Canonical values are:
  • AcctId
  • AcctType
XferFromArray_AType

XferFromArray_AType is an array AType element. This is an array of account identifications transferred from the permission set.

Contains:

  • XferFromInfo_CType
XferFromInfo_CType

XferFromInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XferFromDepType
The account types that can be the recipient of funds transferred from the deposit account type. Canonical values are:
  • Dep
  • Club
  • Ln
  • Prot
  • Sav
  • TimeDep
XferFromLnType
The account types that can be the recipient of funds transferred from the loan account type. Canonical values are:
  • Dep
  • Club
  • Ln
  • Prot
  • Sav
  • TimeDep
XferFromSavType
The account types that can be the recipient of funds transferred from the savings account type. Canonical values are:
  • Dep
  • Club
  • Ln
  • Prot
  • Sav
  • TimeDep

Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Oct 2 2023