Internet Financial Institution Id User Inquiry
Internet Financial Institution Id User Inquiry is a jXchange service designed to provide a list of an internet financial institution's cash management users.
Message Flow
In jXchange, the Internet Financial
Institution Id User Inquiry service uses a typical exchange of MType messages to create a list
of cash management users for a specific internet financial
institution.
Primary Request
The Third Party Consumer forwards the
IntnetFinInstIdUsrInqRq_MType message to the Service
Provider. The message contains the required
IntnetFinInstId element.
Primary Response
The Service Provider returns the
IntnetFinInstIdUsrInqRs_MType message to the Third Party
Consumer. The message contains a multi-occurrence inquiry that includes an
echo that is in response to the elements submitted in the
request.
Internet Financial Institution Id User Inquiry Behavior
The IntFinInstIdUsrInqRq_MType
message request requires the IntnetFinInstId element. The
request allows for the CashMgmtUsrId element to provide
search capabilities for specific users.
The
IntFinInstIdUsrInqRs_MType
message response is a multi-occurrence inquiry that includes an echo of
the elements submitted in the message request.
The IntnetFinInstIdUsrInfoRec_CType
complex contains the EmailArray_AType and DspAppArray_AType arrays. The
DspAppArray_AType array
provides an array of applications that the cash management user has
allowable access. The DspAppAlw default canonical value
is ~false~.
The CashMgmtAcctIdAccessArray_AType
array provides an array of account identifications that the cash
management user has allowable access.
The XSD node design for Cash Management User Inquiry was created to leverage the addition and modification for future messages.
The following is a table of elements with their abbreviated name, canonical values, and default value.
| Element Name | Element Abbreviated Name | Canonical Values | Default Value |
|---|---|---|---|
| Wire Activity Allowed | WireActAlw | true false | false |
| Wire Modification Allowed | WireModAlw | true false | false |
| Wire Repetive Addition Allowed | WireRepAddAlw | true false | false |
| Wire Repetive Modification Allowed <WireRepModAlw> ~true,false~; default = false | WireRepModAlw | true false | false |
| Wire Creation Allowed | WireCrtAlw | true false | false |
| Wire Application Allowed | WireAppAlw | true false | false |
| ACH Allowed | ACHAlw | true false | false |
| ACH Display Allowed | ACHDspAlw | true false | false |
| ACH Transactoin Allowed | ACHTrnAlw | true false | false |
| ACH Batch Allowed | ACHBatchAlw | true false | false |
| ACH Applicatoin Allowed | ACHAppAlw | true false | false |
| ACH Exceptions Allowed | ACHExcAlw | true false | false |
| Current Day Transaction Allowed | CurDayTrnAlw | true false | false |
| Prior Day Transactoin Allowed | PriorDayTrnAlw | true false | false |
| Transactoin History Allowed | TrnHistAlw | true false | false |
| Transaction History Filter Allowed | TrnHistFilterAlw | true false | false |
| Stop Payment Inquiry Allowed | StopPmtInqAlw | true false | false |
| Stop Payment Addition Allowed | StopPmtAddAlw | true false | false |
| Positive Payment Batch Allowed | PosPayBatchAlw | true false | false |
| Positive Payment Exceptions Allowed | PosPayExcAlw | true false | false |
| Account Reconciliation Positive Pay Batch Allowed | AcctReconPosPayBatchAlw | true false | false |
| Account Reconciliation Positive Pay Exceptions Allowed | AcctReconPosPayExcAlw | true false | false |
| Account Reconciliation Positive Pay Transfer Allowed | AcctRecon PosPayTrfAlw | true false | false |
| Import Account Reconciliation Data | ImportAcctReconData | true false | false |
| Funds Transfer Allowed | XferAlw | true false | false |
| Extraction Allowed | ExtcAlw | true false | false |
| Statement Retrieval Allowed | StmtRetrvAlw | true false | false |
| Administrative Activity Allowed | AdminActAlw | true false Part ViewOnly | false |
| EFT Card Status Allowed | EFTCardStatAlw | true false | false |
| Bill Payment Allowed | BillPayAlw | true false | false |
| Electronic Document Addition Allowed | ElecDocAddAlw | true false | false |
| Display Rates Allowed | DspRateAlw | true false | false |
IntnetFinInstIdUsrInqRq_MType
IntnetFinInstIdUsrInqRq_MType is a message
MType element.
Contains:
Custom_CTypeMsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- 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.
- CashMgmtUsrId
- The user identification of cash management users for a specific internet financial institution enrolled client.
- 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.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is the default
message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-Security.
IntnetFinInstIdUsrInqRs_MType
IntnetFinInstIdUsrInqRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CTypeIntnetFinInstIdUsrInqArray_AType
Simple Elements
The simple elements contained within this message are listed below.
- 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.
- AliasAcctName
- An alias name provided to an account that is often used for GUI representation that is understandable to an end consumer.
- 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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-Security.
IntnetFinInstIdUsrInqArray_AType
IntnetFinInstIdUsrInqArray_AType is an array AType
element. This is an array of internet financial institutions cash management user
identifications.
Contains:
IntnetFinInstIdUsrRec_CType