Service Dictionary Search
Service Dictionary Search
Service Dictionary Search is a jXchage messaging service designed to provide consumers a service that can convey a Service Provider's elements XSD path, requirements, default values, open enumerated canonical values, help/knowledge content, and fault codes per operation.
Message Flow
Message flow involves the exchange of MType messages between the Third Party Consumer and the Service Provider.
Primary Request
The Third Party Consumer
forwards the SvcDictSrchRq_MType message
containing:
ElemNameSvcDictNameSvcDictTypeIncXtendElemArray_ATypeSrchMsgRqHdr_CTypeSvcDictFilterArray_AType
The SvcDictName and
SvcDictType are required elements. The
ElemName element and
SvcDictFilterArray_AType array are optional. The
IncXtendElemArray_AType requires submission for the
consumer to be returned the Service Provider's Field Information and
Service Provider Error Array.
Primary Response
The Service Provider returns
the SvcDictSrchRs_MType message containing:
Custom_CTypeSvcDictNameSvcDictTypeSrchMsgRsHdr_CTypeSvcDictFilterArray_ATypeSvcDictInfoArray_ATypex_SvcPrvdErrArray_AType
The response is an echo of the request. The
x_SvcPrvdErrArray_AType included in the root response
provides the consumer with all of the fault/errors that can exist for the
named SvcDictName submitted in the request.
Service Dictionary Search Behavior
The SvcDictSrchRq_MType request message requires valid
SvcDictName and SvcDictType elements. The
SvcDictName canonical values represent the operations that can be
queried. The canonical values are separated by the Third Party Consumer operations and the JHA
Consumer operations. The canonical values could be phased in as adopted by Service Providers.
The SvcDictType element canonical values are Request ~Rq~ and Response ~Rs~. The request includes the
optional element ElemName, so that a consumer could query for the
values as related to a specific child node. When ElemName is populated,
it can also carry the Override Institution Routing Identifier attribute
OvrrdInstRtId to indicate to the service provider the consumer's
intent to gather information about a bank-specific client's information. When
ElemName is left blank, the consumer is requesting information about
the entire service. The Service Dictionary Filter Information Complex
SvcDictFilterInfo_CType can be decorated with
OvrrdInstRtId to convey to the service provider the bank number for
which this information should be returned.
The request includes the optional array SvcDictFilterArray_AType, which
includes the SvcDictFilterInfo_CType. The SvcDictFilterInfo_CType complex
contains the SvcDictFilterCode and
SvcDictFilterVal elements. These two elements present a matched pair
that provides canonical value(s) that allows a consumer to restrict a query for specific
values that have a correlation to an operation. For example, a submission for Account Addition
(<SvcDictName>AcctAdd</SvcDictName>) could include the dictionary values related
to a specific product code (<SvcDictFilterCode>ProdCode</SvcDictFilterCode> and
<SvcDictFilterVal>~product code data value~</SvcDictFilterVal>). However, a
consumer would need to query for the valid product codes by means of the Service Dictionary in
order to make a subsequent call that included the product code as a filter on the request.
The request includes the IncXtendElemArray_AType
array, which requires submission for the consumer to be returned the
Service Providers Field Information and Service Provider Error Array.
The SvcDictSrchRs_MType response message echoes back the request: the
SvcDictName element and SvcDictFilterArray_AType array. The
x_SvcPrvdErrArray_AType
array included at the root response provides the consumer with all of the fault/errors that
can exist for the named SvcDictName submitted in the request. The
SvcDictSrchRs_MType response
message contains the SvcDictInfoArray_AType and x_SvcPrvdErrArray_AType arrays.
The SvcDictInfoArray_AType array includes the
SvcDictInfoRec_CType complex. The
x_SvcPrvdErrArray_AType array includes the
SvcPrvdErrInfo_CType complex. The
SvcDictInfoRec_CType complex includes the child nodes
that define the elements and related information to the element as related
to the requested operation. The SvcDictInfoRec_CType
complex includes the Include Extended complexes for
x_SvcPrvdFldInfo_CType complex and
x_SvcPrvdErrArray_AType array. The
x_SvcPrvdFldInfo_CType complex provides the consumer with
an element's source of record for a Service Provider. The
x_SvcPrvdErrArray_AType array provides the consumer with
the potential fault/errors conditions that can exist for the named element
included by the SvcDictInfoRec_CType complex. The
SvcDictInfoRec_CType complex includes
ElemCanocArray_AType array, which provides the consumer
with an element's open enumerated canonical values. The
ElemCanocArray_AType array includes the
ElemCanocRec_CType complex, which provides the consumer
with the match pair element canonical values and descriptions. The
ElemCanocRec_CType complex includes the
CanocValInfoArray_AType array, which permits a Service
Provider to deliver any pertinent details related to the canonical
value(s). The standard search message header tenets are applicable.
SvcDictSrchRq_MType
SvcDictSrchRq_MType is a message
MType element.
Contains:
IncXtendElem_ATypeSrchMsgRqHdr_CTypeSvcDictFilterArray_AType
Simple Elements
The following simple elements are contained within this message.
- ElemName
- The name provided to an element. It includes the OvrrdInstRtId attribute.
- SvcDictName
- The name of the service to obtain data dictionary definitions.
Canonical values are:
- AcctAdd
- AcctAddValidate
- AcctAnlysAdd
- AcctAnlysInq
- AcctAnlysMod
- AcctAnlysTrnAdd
- AcctBalInq
- AcctBenfAdd
- AcctBenfInq
- AcctBenfMod
- AcctCombStmtAdd
- AcctCombStmtInq
- AcctCombStmtMod
- AcctExcTrnInq
- AcctExcTrnSrch
- AcctHistSrch
- AcctIdGen
- AcctInq
- AcctIntRateInq
- AcctMemoPostSrch
- AcctMod
- AcctNSFTrnInq
- AcctNSFTrnMod
- AcctProdOvrrdAdd
- AcctProdOvrrdInq
- AcctProdOvrrdMod
- AcctProtInq
- AcctSrch
- AcctSweepAdd
- AcctSweepInq
- AcctSweepMod
- ACHCompMultiInq
- ACHCompSrch
- ACHFileAdd
- ACHFileInq
- ACHFileMod
- ACHPndSrch
- ACHTrnAddeSrch
- ACHTrnSrch
- AddrAdd
- AddrInq
- AddrMod
- AddrSrch
- BilPayChanInq
- BilPayPayeeAdd
- BilPayPayeeInq
- BilPayPayeeMod
- BilPayPayeeSrch
- BilPayPmtHistSrch
- BilPayPmtHistInq
- BilPaySchedPmtAdd
- BilPaySchedPmtApprv
- BilPaySchedPmtInq
- BilPaySchedPmtMod
- BilPaySchedPmtSrch
- BilPaySubAdd
- BilPaySubConsmCustInq
- BilPaySubInq
- BilPaySubMod
- BilPaySubSrch
- BrdCstSrch
- ChkImgInq
- ChkImgStmtGen
- ChkImgStmtGenInq
- ChkImgStmtSrch
- InstRtId
- CollatTrackAdd
- CollatTrackAddValidate
- CollatTrackItemInq
- CollatTrackMod
- CollatTrackSrch
- CRBurInfoInq
- CredPolInq
- CRMProspInq
- CurBurInfoAdd
- CrBurInfoAddValidate
- CrBurInfoMod
- CrCardTrnAdd
- CustAcctRelInq
- CustAdd
- CustCollatSrch
- CustIncmInq
- CustInfoMsgInq
- CustInq
- CustMod
- CustMsgAdd
- CustMsgInq
- CustMsgMod
- CustMsgSrch
- CustRelAdd
- CustRelInq
- CustRelMod
- CustSrch
- DocElecSigAdd
- DocImgMod
- EFTCardAcctIdAdd
- EFTCardAdd
- EFTCardAddrSrch
- EFTCardAddValidate
- EFTCardFileMainSrch
- EFTCardInq
- EFTCardMsgAdd
- EFTCardMsgMod
- EFTCardMsgSrch
- EFTCardMod
- EFTCardOrderAdd
- EFTCardPINMod
- EFTCardPINModInit
- EFTCardSrch
- EFTCardTrnHistSrch
- EFTCardUsrQuthInq
- ElecDocInq
- EmplAppAdd
- EmplJobInqTrnSetItemSrch
- EmplJobSrch
- EscrwAdd
- EscrwAddValidate
- EscrwInq
- EscrwMod
- FASB91Add
- FASB91AddValidate
- FASB91Mod
- FASB91Srch
- FileMainSrch
- FinInstInfoInq
- GLAcctInq
- GLAcctSrch
- IdVerifyAdd
- IdVerifyMod
- IntnetFinInstIdAcctAccessInq
- IntnetFinInstAcctIdAdd
- IntnetFinInstAcctIdAddValidate
- IntnetFinInstIdAdd
- IntnetFinInstIdAddValidate
- IntnetFinInstIdFileMainSrch
- IntnetFinInstIdInq
- IntnetFinInstIdMod
- IntnetFinInstIdPINMod
- IntnetFinInstIdUsrInq
- IntnetFinInstIdUsrMod
- IntRateSrch
- IntYieldInq
- LnAcctAdd
- LnAcctAddValidate
- LnAcctMod
- LnAppRgtrAdd
- LnAppRgtrAddValidate
- LnAppRgtrMod
- LnAppRgtrSrch
- LnBilSrch
- LnFeeSrch
- LnLiabInq
- LnPayoffInq
- LnPltfmAppAdd
- LnPltfmProdSrch
- LogSrch
- PltfmStatInq
- LnPmtExt
- LnPmtSchedAdd
- LnPmtSchedAddValidate
- LnPmtSchedInq
- LnPmtSchedMod
- LnPrtcpInq
- LnRateSchedInq
- LnRateSchedMod
- LnRateSchedSrch
- LnRegLTVInq
- LnRen
- LnSvcInq
- LnUnitInq
- LnUnitSrch
- LOCAcctInq
- LOCAcctSrch
- LOCAdd
- LOCAddValidate
- LOCMod
- LOCSrch
- LtrofCrInq
- MFAActRiskInq
- MFAOOBValidate
- MFAOTPCredGen
- MFAOTPCredValidate
- MFAUsrQnAMod
- MFATokenAdd
- MFATokenMod
- MFATokenInq
- MFATokenPINMod
- MFATokenTempPswdInq
- MFATokenValidate
- MFATokenUsrAdd
- MFATokenUsrMod
- MFATokenUsrInq
- MFAQnAPolInq
- MFASecdRiskInq
- MFAUsrConsmCredAdd
- MFAUsrConsmCredInq
- MFAUsrConsmCredMod
- MFAUsrConsmCredSrch
- MFAUsrQnAAdd
- MFAUsrQnAInq
- MFAUsrQnAMod
- MFAUsrQnAValidate
- MFAWaterMarkSrch
- NSFHistSrch
- ODISvcCred
- ODPrvlgHistSrch
- OFACSrch
- PersonNameMod
- PingAll
- PltfmAppAdd
- PltfmProdInq
- PltfmStatInq
- PltfmStatMod
- PosPayItemInq
- PosPayItemMod
- PosPayItemInq
- PubWorkflowSrch
- RealEstatePropAdd
- RelaEstatePropAddValidate
- RealEstatePropMod
- RealEstatePropSrch
- SafeDepBoxSrch
- SafeDepPmtAdd
- SafeDepPmtMod
- StopChkAdd
- StopChkAddValidate
- StopChkCan
- StopChkInq
- StopChkMod
- StopChkSrch
- SvcDictSrch
- SvcFeeSrch
- SvcFeeTrnAdd
- SvcFeeTrnInq
- SvcFeeTrnMod
- TaxPlnAcctSrch
- TaxPlnAdd
- TaxPlnAddValidate
- TaxPlnBenfAdd
- TaxPlnBenfAddValidate
- TaxPlnBenfInq
- TaxPlnBenfMod
- TaxPlnBenfSrch
- TaxPlnInq
- TaxPlnMod
- TaxPlnSrch
- TellerCurrTrnAdd
- TellerCurrTrnInq
- TellerCurrTrnMod
- TellerCurrTrnSrch
- TellerCustSrch
- TellerDrwMod
- TellerNonCustAdd
- TellerNonCustInq
- TellernonCustMod
- TellerTrnAdd
- TellerTrnInq
- TellerTrnMod
- TellerTrnSrch
- TimeDepRenOvrrd
- TimeDepRenOvrrdInq
- TrnAdd
- TrnAddValidate
- TrnMod
- UsrConsmCredAdd
- UsrConsmCredMod
- UsrEnrollInq
- UsrOperInq
- WireCompInq
- WireCompSrch
- WireHistSrch
- WireTrnInq
- WireTrnInq
- WorkflowInstcStart
- XferAdd
- XferAddValidate
- XferMod
- XferSrch
- XferSrcDestSrch
- SvcDictType
- The type of service dictionary operation type. Canonical values
are:
- Rq
- Rs
IncXtendElemArray_AType
IncXtendElemArray_AType is an array AType element. This is an array that
lists x_ elements by name, which are to be included in the response.
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_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.
- 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_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 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_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.
SvcDictFilterArray_AType
SvcDictFilterArray_AType is an array
AType element. It is an array of filters that is available
for the Service Dictionary service.
Contains:
SvcDictFilterInfo_CType
SvcDictFilterInfo_CType
SvcDictFilterInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- SvcDictFilterCode
- Filters that can be used to provide the consumer a means to
define the specific dictionary values for a specific service. Canonical
values are:
- AcctAdd:
- AcctType
- BrCode
- ProdCode
- RegionCode
- BilPaySubInq:
- MobPrvdCod
- BilPaySubMod:
- MobPrvdCod
- CollatTrackAdd:
- AcctId
- AcctType
- CollatCode
- CollatDoc
- CollatDocCode
- CollatItem
- CustId
- CRMActAdd:
- CRMActType
- OffInstRtId
- CRMActInq:
- CRMActType
- CRMActMod:
- CRMActType
- OffInstRtId
- CRMEventAdd:
- CRMEventType
- CustId
- EventCatCode
- EventCatDesc
- EventOffCode
- EventPrivType
- OffInstRtId
- TaxId
- CRMEventInq:
- CRMEventType
- CRMEventMod:
- CRMEventType
- CRMEventId
- CustId
- EventCatCode
- EventCatDesc
- EventOffCode
- EventPrivType
- OffInstRtId
- TaxId
- CRMReferAdd:
- CustId
- EventPrivType
- OffInstRtId
- ReferOffCode
- TaxId
- CRMReferMod:
- EventPrivType
- OffInstRtId
- ReferId
- ReferOffCode
- DocImgAdd:
- DocImgIdxType
- EscrwAdd:
- AcctType
- EscrwTypeCode
- FASB91Add:
- AcctId
- AcctType
- FASB91Cat
- LnAppRgtrAdd:
- AppDt
- LnAppRgtrAddValidate:
- AppDt
- LnAppRgtrMod:
- AppDt
- LnFeeAdd:
- AcctId
- AcctType
- LnFeeCode
- LobbyQueAdd:
- BrCode
- StopChkAdd:
- AcctId
- AcctType
- ProdCode
- StopHldType
- TaxPlnAdd:
- PlnCode
- TrnAdd:
- AcctType
- BrCode
- XferAdd:
- FromAcctId
- FromAcctType
- ToAcctId
- ToAcctType
- XferType
- WireTmpltAdd:
- WireAcctId
- WireAcctType
- AcctAdd:
- SvcDictFilterVal
- The values that correlate with the Service Dictionary filter canonical values.
SvcDictSrchRs_MType
SvcDictSrchRs_MType is a message
MType element.
Contains:
Custom_CTypeSrchMsgRsHdr_CTypeSvcDictFilterArray_ATypeSvcDictInfoArray_ATypex_SvcPrvdErrArray_AType
Simple Elements
The following simple elements are contained within this message.
- SvcDictName
- The name of the service to obtain data dictionary definitions.
Canonical values are:
- AcctAdd
- AcctAddValidate
- AcctAnlysAdd
- AcctAnlysInq
- AcctAnlysMod
- AcctAnlysTrnAdd
- AcctBalInq
- AcctBenfAdd
- AcctBenfInq
- AcctBenfMod
- AcctCombStmtAdd
- AcctCombStmtInq
- AcctCombStmtMod
- AcctExcTrnInq
- AcctExcTrnSrch
- AcctHistSrch
- AcctIdGen
- AcctInq
- AcctIntRateInq
- AcctMemoPostSrch
- AcctMod
- AcctNSFTrnInq
- AcctNSFTrnMod
- AcctProdOvrrdAdd
- AcctProdOvrrdInq
- AcctProdOvrrdMod
- AcctProtInq
- AcctSrch
- AcctSweepAdd
- AcctSweepInq
- AcctSweepMod
- ACHCompMultiInq
- ACHCompSrch
- ACHFileAdd
- ACHFileInq
- ACHFileMod
- ACHPndSrch
- ACHTrnAddeSrch
- ACHTrnSrch
- AddrAdd
- AddrInq
- AddrMod
- AddrSrch
- BilPayChanInq
- BilPayPayeeAdd
- BilPayPayeeInq
- BilPayPayeeMod
- BilPayPayeeSrch
- BilPayPmtHistSrch
- BilPayPmtHistInq
- BilPaySchedPmtAdd
- BilPaySchedPmtApprv
- BilPaySchedPmtInq
- BilPaySchedPmtMod
- BilPaySchedPmtSrch
- BilPaySubAdd
- BilPaySubConsmCustInq
- BilPaySubInq
- BilPaySubMod
- BilPaySubSrch
- BrdCstSrch
- ChkImgInq
- ChkImgStmtGen
- ChkImgStmtGenInq
- ChkImgStmtSrch
- InstRtId
- CollatTrackAdd
- CollatTrackAddValidate
- CollatTrackItemInq
- CollatTrackMod
- CollatTrackSrch
- CRBurInfoInq
- CredPolInq
- CRMProspInq
- CurBurInfoAdd
- CrBurInfoAddValidate
- CrBurInfoMod
- CrCardTrnAdd
- CustAcctRelInq
- CustAdd
- CustCollatSrch
- CustIncmInq
- CustInfoMsgInq
- CustInq
- CustMod
- CustMsgAdd
- CustMsgInq
- CustMsgMod
- CustMsgSrch
- CustRelAdd
- CustRelInq
- CustRelMod
- CustSrch
- DocElecSigAdd
- DocImgMod
- EFTCardAcctIdAdd
- EFTCardAdd
- EFTCardAddrSrch
- EFTCardAddValidate
- EFTCardFileMainSrch
- EFTCardInq
- EFTCardMsgAdd
- EFTCardMsgMod
- EFTCardMsgSrch
- EFTCardMod
- EFTCardOrderAdd
- EFTCardPINMod
- EFTCardPINModInit
- EFTCardSrch
- EFTCardTrnHistSrch
- EFTCardUsrQuthInq
- ElecDocInq
- EmplAppAdd
- EmplJobInqTrnSetItemSrch
- EmplJobSrch
- EscrwAdd
- EscrwAddValidate
- EscrwInq
- EscrwMod
- FASB91Add
- FASB91AddValidate
- FASB91Mod
- FASB91Srch
- FileMainSrch
- FinInstInfoInq
- GLAcctInq
- GLAcctSrch
- IdVerifyAdd
- IdVerifyMod
- IntnetFinInstIdAcctAccessInq
- IntnetFinInstAcctIdAdd
- IntnetFinInstAcctIdAddValidate
- IntnetFinInstIdAdd
- IntnetFinInstIdAddValidate
- IntnetFinInstIdFileMainSrch
- IntnetFinInstIdInq
- IntnetFinInstIdMod
- IntnetFinInstIdPINMod
- IntnetFinInstIdUsrInq
- IntnetFinInstIdUsrMod
- IntRateSrch
- IntYieldInq
- LnAcctAdd
- LnAcctAddValidate
- LnAcctMod
- LnAppRgtrAdd
- LnAppRgtrAddValidate
- LnAppRgtrMod
- LnAppRgtrSrch
- LnBilSrch
- LnFeeSrch
- LnLiabInq
- LnPayoffInq
- LnPltfmAppAdd
- LnPltfmProdSrch
- LogSrch
- PltfmStatInq
- LnPmtExt
- LnPmtSchedAdd
- LnPmtSchedAddValidate
- LnPmtSchedInq
- LnPmtSchedMod
- LnPrtcpInq
- LnRateSchedInq
- LnRateSchedMod
- LnRateSchedSrch
- LnRegLTVInq
- LnRen
- LnSvcInq
- LnUnitInq
- LnUnitSrch
- LOCAcctInq
- LOCAcctSrch
- LOCAdd
- LOCAddValidate
- LOCMod
- LOCSrch
- LtrofCrInq
- MFAActRiskInq
- MFAOOBValidate
- MFAOTPCredGen
- MFAOTPCredValidate
- MFAUsrQnAMod
- MFATokenAdd
- MFATokenMod
- MFATokenInq
- MFATokenPINMod
- MFATokenTempPswdInq
- MFATokenValidate
- MFATokenUsrAdd
- MFATokenUsrMod
- MFATokenUsrInq
- MFAQnAPolInq
- MFASecdRiskInq
- MFAUsrConsmCredAdd
- MFAUsrConsmCredInq
- MFAUsrConsmCredMod
- MFAUsrConsmCredSrch
- MFAUsrQnAAdd
- MFAUsrQnAInq
- MFAUsrQnAMod
- MFAUsrQnAValidate
- MFAWaterMarkSrch
- NSFHistSrch
- ODISvcCred
- ODPrvlgHistSrch
- OFACSrch
- PersonNameMod
- PingAll
- PltfmAppAdd
- PltfmProdInq
- PltfmStatInq
- PltfmStatMod
- PosPayItemInq
- PosPayItemMod
- PosPayItemInq
- PubWorkflowSrch
- RealEstatePropAdd
- RelaEstatePropAddValidate
- RealEstatePropMod
- RealEstatePropSrch
- SafeDepBoxSrch
- SafeDepPmtAdd
- SafeDepPmtMod
- StopChkAdd
- StopChkAddValidate
- StopChkCan
- StopChkInq
- StopChkMod
- StopChkSrch
- SvcDictSrch
- SvcFeeSrch
- SvcFeeTrnAdd
- SvcFeeTrnInq
- SvcFeeTrnMod
- TaxPlnAcctSrch
- TaxPlnAdd
- TaxPlnAddValidate
- TaxPlnBenfAdd
- TaxPlnBenfAddValidate
- TaxPlnBenfInq
- TaxPlnBenfMod
- TaxPlnBenfSrch
- TaxPlnInq
- TaxPlnMod
- TaxPlnSrch
- TellerCurrTrnAdd
- TellerCurrTrnInq
- TellerCurrTrnMod
- TellerCurrTrnSrch
- TellerCustSrch
- TellerDrwMod
- TellerNonCustAdd
- TellerNonCustInq
- TellernonCustMod
- TellerTrnAdd
- TellerTrnInq
- TellerTrnMod
- TellerTrnSrch
- TimeDepRenOvrrd
- TimeDepRenOvrrdInq
- TrnAdd
- TrnAddValidate
- TrnMod
- UsrConsmCredAdd
- UsrConsmCredMod
- UsrEnrollInq
- UsrOperInq
- WireCompInq
- WireCompSrch
- WireHistSrch
- WireTrnInq
- WireTrnInq
- WorkflowInstcStart
- XferAdd
- XferAddValidate
- XferMod
- XferSrch
- XferSrcDestSrch
- SvcDictType
- The type of service dictionary operation type. Canonical values
are:
- Rq
- Rs
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex
CType element. It searches
specific message response headers.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_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_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 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_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.
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.
SvcDictFilterArray_AType
SvcDictFilterArray_AType is an array
AType element. It is an array of filters that is available
for the Service Dictionary service.
Contains:
SvcDictFilterInfo_CType
SvcDictFilterInfo_CType
SvcDictFilterInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- SvcDictFilterCode
- Filters that can be used to provide the consumer a means to
define the specific dictionary values for a specific service. Canonical
values are:
- AcctAdd:
- AcctType
- BrCode
- ProdCode
- RegionCode
- BilPaySubInq:
- MobPrvdCod
- BilPaySubMod:
- MobPrvdCod
- CollatTrackAdd:
- AcctId
- AcctType
- CollatCode
- CollatDoc
- CollatDocCode
- CollatItem
- CustId
- CRMActAdd:
- CRMActType
- OffInstRtId
- CRMActInq:
- CRMActType
- CRMActMod:
- CRMActType
- OffInstRtId
- CRMEventAdd:
- CRMEventType
- CustId
- EventCatCode
- EventCatDesc
- EventOffCode
- EventPrivType
- OffInstRtId
- TaxId
- CRMEventInq:
- CRMEventType
- CRMEventMod:
- CRMEventType
- CRMEventId
- CustId
- EventCatCode
- EventCatDesc
- EventOffCode
- EventPrivType
- OffInstRtId
- TaxId
- CRMReferAdd:
- CustId
- EventPrivType
- OffInstRtId
- ReferOffCode
- TaxId
- CRMReferMod:
- EventPrivType
- OffInstRtId
- ReferId
- ReferOffCode
- DocImgAdd:
- DocImgIdxType
- EscrwAdd:
- AcctType
- EscrwTypeCode
- FASB91Add:
- AcctId
- AcctType
- FASB91Cat
- LnAppRgtrAdd:
- AppDt
- LnAppRgtrAddValidate:
- AppDt
- LnAppRgtrMod:
- AppDt
- LnFeeAdd:
- AcctId
- AcctType
- LnFeeCode
- LobbyQueAdd:
- BrCode
- StopChkAdd:
- AcctId
- AcctType
- ProdCode
- StopHldType
- TaxPlnAdd:
- PlnCode
- TrnAdd:
- AcctType
- BrCode
- XferAdd:
- FromAcctId
- FromAcctType
- ToAcctId
- ToAcctType
- XferType
- WireTmpltAdd:
- WireAcctId
- WireAcctType
- AcctAdd:
- SvcDictFilterVal
- The values that correlate with the Service Dictionary filter canonical values.
SvcDictInfoArray_AType
SvcDictInfoArray_AType is an array
AType element. This is an array of dictionary information
for a specific service.
Contains:
SvcDictInfoRec_CType
SvcDictInfoRec_CType
SvcDictInfoRec_CType is a complex
CType element.
Contains:
ElemCanocArray_ATypex_SvcPrvdErrArray_ATypex_SvcPrvdFldInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ElemCanocType
- The service provider's canonical type. Canonical values are:
- Closed
- NA
- Open
The default is NA.
- ElemDftDt
- The date default of the element when it is not delivered in a payload.
- ElemDft
- The data default of the element when it is not delivered in a payload.
- ElemHelpInfo
- Help content that could include behavior or any important information that might be advantageous to a consumer.
- ElemHighRngDt
- The highest value from the service provider's known data set for a date element.
- ElemHighRngVal
- The highest value from the service provider's known data set for the element.
- ElemInstHelpInfo
- The help and knowledge base information for a specific installation.
- ElemLowRngDt
- The lowest value from the service provider's known data set for a date element.
- ElemLowRngVal
- The lowest value from the service provider's known data set for the element.
- ElemName
- The name provided to an element. It includes the OvrrdInstRtId attribute.
- ElemPath
- The path of the element.
- ElemReq
- If the element is required. Canonical values are:
- false
- true
ElemCanocArray_AType
ElemCanocArray_AType is an array
AType element. This is an array of canonical values as
related to a specific element.
Contains:
ElemCanocRec_CType
ElemCanocRec_CType
ElemCanocRec_CType is a complex
CType element.
Contains:
CanocValInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- ElemCanocVal
- The canonical value for a specific element.
- ElemCanocValDesc
- The description of the canonical value for a specific element.
CanocValInfoArray_AType
CanocValInfoArray_AType is an array AType element. This is an array of information for each service provider canonical
value.
Contains:
CanocValInfo_CType
CanocValInfo_CType
CanocValInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- CanocValDetail
- Any service provider's important details related to the canonical value.
- CanocValTxt
- Any service provider's text related to the canonical value.
x_SvcPrvdErrArray_AType
x_SvcPrvdErrArray_AType is an array
AType element. This is an array of errors, faults, and/or
warnings that could be returned for a specific element.
Contains:
SvcPrvdErrInfo_CType
SvcPrvdErrInfo_CType
SvcPrvdErrInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- SvcPrvdErrCat
- The Soap Header Fault error category.
- SvcPrvdErrCode
- The Soap Header Fault error code.
- SvcPrvdErrDesc
- The Soap Header Fault error description.
- SvcPrvdRegEx
- The service provider's pattern that would generate the error code as expressed as a regular expression. The pattern consists of constants and operators as defined by the formal language theory in a regular expression.
x_SvcPrvdFldInfo_CType
x_SvcPrvdFldInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- SvcPrvdFldDecPosit
- The service provider's database source field decimal positions.
- SvcPrvdFldDesc
- The service provider's database source field description.
- SvcPrvdFldLen
- The service provider's database source field length.
- SvcPrvdFldName
- The service provider's database source field name.
- SvcPrvdFldType
- The service provider's database source field type. Canonical
values are:
- Date
- Dec
- Ink
- String
- Time
- URI
- SvcPrvdTblName
- The service provider's database source table name.
x_SvcPrvdErrArray_AType
x_SvcPrvdErrArray_AType is an array
AType element. This is an array of errors, faults, and/or
warnings that could be returned for a specific element.
Contains:
SvcPrvdErrInfo_CType
SvcPrvdErrInfo_CType
SvcPrvdErrInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- SvcPrvdErrCat
- The Soap Header Fault error category.
- SvcPrvdErrCode
- The Soap Header Fault error code.
- SvcPrvdErrDesc
- The Soap Header Fault error description.
- SvcPrvdRegEx
- The service provider's pattern that would generate the error code as expressed as a regular expression. The pattern consists of constants and operators as defined by the formal language theory in a regular expression.