Wire Investigation Modification
Wire Investigation Modification
Wire Investigation Modification is a jXchange service that allows the consumer to modify wire investigations.
Message Flow
In jXchange, the Wire Investigation Modification service uses a typical
exchange of MType messages
to allow consumers to modify wire investigations.
Primary Request
The consumer forwards the WireInvstgModRq_MType message to
the service provider.
The message contains the following simple elements:
- ActIntent
- Dlt
- TrnRcptId
- WireTrnRoleType
- WireUsrId
- WireVerifId
The message contains the following complex elements:
Custom_CTypeSrchMsgRqHdr_CType
This message contains the following arrays:
ErrOvrrdInfoArray_ATypeModRmkArrayreferencesRmk_AType
Primary Response
The service provider returns the WireInvstgModRs_MType message to
the consumer.
The message contains the following simple element:
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
Wire Investigation Modification Behavior
The Wire Investigation Modification (WireInvstgMod) service behavior is as
follows.
The Wire Investigation Modification root request (WireInvstgModRq_MType)
requires Transaction Receipt ID (TrnRcptId), Wire Transaction Role Type
(WireTrnRoleType), and Activity Intention Key
(ActIntentKey). The Wire Investigation Modification root request
(WireInvstgModRq_MType) optionally includes Wire Investigation Modification
Information complex (WireInvstgModInfo_CType), Wire Investigation Reply
Modification Information complex (WireInvstgReplyModInfo_CType), Wire User
Identifier (WireUsrId), Wire Verification Identifier
(WireVerifId), Delete (Dlt), and Modification
Remark Array (ModRmkArray_AType).
The Transaction Receipt Identifier (TrnRcptId) must be able to
differentiate between an investigation request and an investigation reply. The Wire
Investigation Modification Information complex (WireInvstgModInfo_CType) and
Wire Investigation Reply Modification Information complex
(WireInvstgReplyModInfo_CType) are part of a documented choice statement
whereas one of the complexes is required when not deleting a record.
The Wire Investigation Modification Information complex
(WireInvstgModInfo_CType) encapsulates IMAD (IMAD),
Request Message ID (RqMsgId), Response Message ID
(RsMsgId), Requesting Financial Institution Routing ID
(RqFinInstRtId), Responding Financial Institution Routing ID
(RsFinInstRtId), Wire Request Investigation Code
(WireRqInvstgCode), Wire Sub Request Investigation Code
(WireSubRqInvstgCode), Wire Processing Activity Type
(WireProcActType), Wire Initiated Original Information complex
(WireInitOrigInfo_CType), Wire Intra Original Information complex
(WkreIntrOrigInfo_CType), Wire Investigation Request Array
(WireInvstgRqArray_AType) which encapsulates Wire Investigation Request
Record complex (WireInvstgRqRec_CType), which encapsulates Wire Investigation
Request Code (WireInvstgRqCode), and Wire Investigation Request Remarks
(WireInvstgRqRmk).
The Wire Investigation Reply Modification Information complex
(WireInvstgReplyModInfo_CType) encapsulates IMAD
(IMAD), Response Message ID (RsMsgId), Wire
Response Investigation Status (WireRsInvstgStat), Wire Response Status
Type (WireRsStatType), Wire Processing Activity Type
(WireProcActType), Wire Investigation Response Remark Array
(WireInvstgRsRmkArray_AType), Requesting Financial Institution Routing ID
(RqFinInstRtId), and Responding Financial Institution Routing ID
(RsFinInstRtId).
The Wire Investigation Modification root response (WireInvstgModRs_MType)
returns Response Status (RsStat).
Adhere to the behavior as related to modification service.
WireInvstgModRq_MType
WireInvstgModRq_MType is a message
MType element.
Contains:
Custom_CTypeErrOvrrdInfoArray_ATypeModRmkArrayreferencesRmk_ATypeMsgRqHdr_CTypeWireInvstgReplyModInfo_CTypeWireInvstgModInfo_CType
Simple Elements
The following simple elements are contained within this message:
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
- Dlt
The delete element. Canonical values are:
- false
- true
- TrnRcptId
- The receipt provided for a successful transaction entry.
- WireTrnRoleType
- Identifies the type of role specific to wire non-value
transactions. Canonical values are:
- Requestor
- Responder
- WireUsrId
- The applications' user identification for the transactional activity.
- WireVerifId
- The verification identification associated with a wire user identification for wire business activity permission.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ModRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
ModRmkArray references Rmk_Atype.
Contains:
RmkInfo_CType
RmkInfo_CType
RmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Rmk
- Application or user remarks free-form text.
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 submitted message. A
financial institution entity uses the routing transit or ABA nine-digit number
assigned to financial institutions for the purpose of 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 uses a mutually
agreed upon identification that must contain at least one non-integer character.
When a record is directed to a specific financial institution within a holding
company, the institution routing identification is the specific financial
institution routing identification and not the holding company identification.
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.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array
AType element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_CType is a complex CType element. This
element is used to override errors created in a previous request. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
WireInvstgModInfo_CType
WireInvstgModInfo_CType is a complex
CType element.
Contains:
Custom_CTypeWireInitOrigInfo_CTypeWireIntrOrigInfo_CTypeWireInvstgRqArray_ATypeWireSvcPrvdInfo_CType
Simple Elements
The following simple elements are contained within this message:
- IMAD
- The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
- RqFinInstRtId
- The financial institution's routing and transit identification. The JHANull and Rstr elements are optional.
- RqMsgId
- An identification provided by the logging consumer product that defines the message. The JHANull and Rstr elements are optional.
- RsFinInstRtId
- The financial institution's routing and transit identification. The JHANull and Rstr elements are optional.
- RsMsgId
- An identification provided by the logging consumer product that defines the message. The JHANull and Rstr elements are optional.
- WireInvstgRqCode
- Identifies the reason for the investigation request.
- WireSubRqInvstgCode
- Identifies the subreason for the investigation request.
- WireProcActType
- The action as related to a wire process. Canonical values are:
- Acpt
- Cmplt
- Denied
- Send
- Pend
- Reset
- Resend
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireInitOrigInfo_CType
WireInitOrigInfo_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex:
- RefId
- The wire reference identification provided to a transaction.
- IMAD
- The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
- InstrAmt
- The transactional amount of the wire transfer.
- InstrId
- The instruction identification is a point-to-point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.
- MsgCode
- The type of message.
- PmtDueDt
- The date established for a scheduled payment.
- PmtDueTimeDt
- The time and date the wire transaction was due. Expressed in ISO 8601 time format and should contain either Zulu time or local time and the UTC offset.
- PmtId
- The identification of a payment.
- UETR
- A universally unique identifier to provide an end-to-end reference.
- WireCrtTimeDt
- The time and date the wire transaction was created.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireIntrOrigInfo_CType
WireIntrOrigInfo_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex:
- CurrType
- The alphanumeric ISO 4217 currency code.
- IMAD
- The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
- InstrId
- The instruction identification is a point-to-point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.
- InstrTrnId
- Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.
- MsgCode
- The type of message.
- RefId
- The wire reference identification provided to a transaction.
- UETR
- A universally unique identifier to provide an end-to-end reference.
- WireAmt
- The transactional amount of the wire transfer.
- WireCrtTimeDt
- The time and date the wire transaction was created.
- WireSttlDt
- The date the wire transaction was settled.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireInvstgRqArray_AType
WireInvstgRqArray_AType is an array
AType element. This element is an array of investigations being requested for
a wire.
Contains:
WireInvstgRqRec_CType
WireInvstgRqRec_CType
WireInvstgRqRec_CType
is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex:
- WireInvstgRqCode
- Identifies the reason for the investigation request.
- WireInvstgRqRmk
- Application or user remarks free-form text.
- WireSubRqInvstgCode
- Identifies the subreason for the investigation request.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireSvcPrvdInfo_CType
WireSvcPrvdInfo_CType is a complex CType element.
Contains:
Custom_CTypeWireSchedRecArray_CType
Simple Elements
The following simple elements are contained within this complex.
- AvlBalCalcCode
- A code that conveys to the service provider the method to use for the calculation of the available balance.
- BrCode
- The branch code.
- FornWireType
- The element identifying if a wire is foreign or domestic. Canonical
values are:
- false
- true
- blank
- FraudRefId
- A unique identification provided by the fraud risk application when a request for review is submitted.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- InPersonWireType
- The element identifying if wire was initiated in person. Canonical
values are:
- true
- false
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- OffCode
- The code that designates the financial institution officer.
- RemitSubjRuleType
- Is the wire subject to the remittance rule? Canonical values are:
- true
- false
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - TmpltAlwIntnetCashUsr
- Answers the question: Is the template allowed to be used by the
internet cash user? Canonical values are:
- true
- false
- WireAcctId
- The account identification related to wires.
- WireAcctType
- The number or character that categorizes the AcctId.
- WireAnlysCode
- The code that identifies the behavior for Account Analysis activity for the transaction.
- WireCompEmplId
- The identification given to a company's employee.
- WireCompEmplName
- The employer name.
- WireCompId
- The company identification for wire created transactions.
- WireCompVerifId
- The verification identification associated with a wire user identification for wire business activity permission.
- WireCompVerifName
- The employer name.
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WireFeeAmt
- The fee amount associated with a transaction.
- WireNotType
Identifies the behavior for wire notification for a transaction. Canonical values are:
- Fax
- None
- Prt
- EmailFax
- EmailPrt
- WireSrc
- Identifies the source entry of the wire transaction. Canonical
values are:
- DirectLine
- FIClerk
- Intnet
- WireSrcDestCode
- The code that describes the source and/or destination of a wire for delivery of the wire.
- WireSrcDestDesc
- The description of the code that describes the source and/or destination of a wire for delivery of the wire
- WireStat
- Identifies the status of the wire transaction.
- WireTmpltCode
- The code that represent the type of wire template.
- WireTempltRef
- An application's transactional reference that provides guidance as to the source.
- WireTmpltCrt
Answers the question: Should a wire template be created for the wire transaction? Canonical values are:
- false
- true
- TempltOnly
The default value is False.
- WireTmpltDesc
- The readable description assigned to a wire template.
- WireTrnType
- Identifies the wire transactional activity. Canonical values
are:
- Both
- Incoming
- Outgoing
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireSchedRecArray_AType
WireSchedRecArray_AType is an array AType element.
This is an array of responses for wire schedules.
Contains:
WireSchedRec_CType
WireSchedRec_CType
WireSchedRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Amt
- The amount or quantity.
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- SemiDay1
- The day of the month for first semi-monthly payment.
- SemiDay2
- The day of month for second semi-monthly payment.
- WireInitDt
- The date a wire entry was initiated.
- WireInitTime
- The time a wire entry was initiated.
- WireSchedDayOfMonth
- The day of the month for transfer transaction. This day is only required if the transfer date is the 29th of the month.
- WireSchedDayOfWeekOccur
- The day of week occurrence. Canonical values are:
- First
- Secd
- Third
- Fourth
- Last
- WireSchedDayOfWeek
- The day of the week. Canonical values are:
- Mon
- Tues
- Wed
- Thur
- Fri
- Sat
- Sun
- WireSchedExpDt
- The expiration date of the transfer request.
- WireSchedFirstDt
- The first date to start a future transfer request.
- WireSchedFreq
- The frequency of the transfer.
- WireSchedFreqUnits
- The units of frequency for the transfer request. Canonical values
are:
- BiWeekSkipFirst
- BiWeekSkipLast
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- WeekSkipFirst
- WeekSkipLast
- Years
- WireSchedId
- An identifier provided for the reoccurring schedule.
- WireSchedNextDt
- The next scheduled transfer date.
- WireSchedStat
- Identifies the status of the future transfer schedule. Canonical
values are:
- Active
- Expired
- Suspended
WireInvstgReplyModInfo_CType
WireInvstgReplyModInfo_CType is a
complex CType element.
Contains:
Custom_CTypeWireInvstgRsRmkArrayreferencesRmk_ATypeWireSvcPrvdInfo_CType
Simple Elements
The following simple elements are contained within this message:
- IMAD
- The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
- RqFinInstRtId
- The financial institution's routing and transit identification. The JHANull and Rstr elements are optional.
- RsFinInstRtId
- The financial institution's routing and transit identification. The JHANull and Rstr elements are optional.
- RsFinInstRtId
- The financial institution's routing and transit identification. The JHANull and Rstr elements are optional.
- RsMsgId
- An identification provided by the logging consumer product that defines the message. The JHANull and Rstr elements are optional.
- WireProcActType
- The action as related to a wire process. Canonical values are:
- Acpt
- Cmplt
- Denied
- Send
- Pend
- Reset
- Resend
- WireRsInvstgStat
- The status of the investigation request.
- WireRsStatType
- Identifies the status of the information request. Canonical values
are:
- Cls
- Pend
- Rej
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireInvstgRsRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireInvstgRsRmkArray references Rmk_AType.
Contains:
RmkInfo_CType
RmkInfo_CType
RmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Rmk
- Application or user remarks free-form text.
WireSvcPrvdInfo_CType
WireSvcPrvdInfo_CType is a complex CType element.
Contains:
Custom_CTypeWireSchedRecArray_CType
Simple Elements
The following simple elements are contained within this complex.
- AvlBalCalcCode
- A code that conveys to the service provider the method to use for the calculation of the available balance.
- BrCode
- The branch code.
- FornWireType
- The element identifying if a wire is foreign or domestic. Canonical
values are:
- false
- true
- blank
- FraudRefId
- A unique identification provided by the fraud risk application when a request for review is submitted.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- InPersonWireType
- The element identifying if wire was initiated in person. Canonical
values are:
- true
- false
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- OffCode
- The code that designates the financial institution officer.
- RemitSubjRuleType
- Is the wire subject to the remittance rule? Canonical values are:
- true
- false
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - TmpltAlwIntnetCashUsr
- Answers the question: Is the template allowed to be used by the
internet cash user? Canonical values are:
- true
- false
- WireAcctId
- The account identification related to wires.
- WireAcctType
- The number or character that categorizes the AcctId.
- WireAnlysCode
- The code that identifies the behavior for Account Analysis activity for the transaction.
- WireCompEmplId
- The identification given to a company's employee.
- WireCompEmplName
- The employer name.
- WireCompId
- The company identification for wire created transactions.
- WireCompVerifId
- The verification identification associated with a wire user identification for wire business activity permission.
- WireCompVerifName
- The employer name.
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WireFeeAmt
- The fee amount associated with a transaction.
- WireNotType
Identifies the behavior for wire notification for a transaction. Canonical values are:
- Fax
- None
- Prt
- EmailFax
- EmailPrt
- WireSrc
- Identifies the source entry of the wire transaction. Canonical
values are:
- DirectLine
- FIClerk
- Intnet
- WireSrcDestCode
- The code that describes the source and/or destination of a wire for delivery of the wire.
- WireSrcDestDesc
- The description of the code that describes the source and/or destination of a wire for delivery of the wire
- WireStat
- Identifies the status of the wire transaction.
- WireTmpltCode
- The code that represent the type of wire template.
- WireTempltRef
- An application's transactional reference that provides guidance as to the source.
- WireTmpltCrt
Answers the question: Should a wire template be created for the wire transaction? Canonical values are:
- false
- true
- TempltOnly
The default value is False.
- WireTmpltDesc
- The readable description assigned to a wire template.
- WireTrnType
- Identifies the wire transactional activity. Canonical values
are:
- Both
- Incoming
- Outgoing
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireSchedRecArray_AType
WireSchedRecArray_AType is an array AType element.
This is an array of responses for wire schedules.
Contains:
WireSchedRec_CType
WireSchedRec_CType
WireSchedRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Amt
- The amount or quantity.
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- SemiDay1
- The day of the month for first semi-monthly payment.
- SemiDay2
- The day of month for second semi-monthly payment.
- WireInitDt
- The date a wire entry was initiated.
- WireInitTime
- The time a wire entry was initiated.
- WireSchedDayOfMonth
- The day of the month for transfer transaction. This day is only required if the transfer date is the 29th of the month.
- WireSchedDayOfWeekOccur
- The day of week occurrence. Canonical values are:
- First
- Secd
- Third
- Fourth
- Last
- WireSchedDayOfWeek
- The day of the week. Canonical values are:
- Mon
- Tues
- Wed
- Thur
- Fri
- Sat
- Sun
- WireSchedExpDt
- The expiration date of the transfer request.
- WireSchedFirstDt
- The first date to start a future transfer request.
- WireSchedFreq
- The frequency of the transfer.
- WireSchedFreqUnits
- The units of frequency for the transfer request. Canonical values
are:
- BiWeekSkipFirst
- BiWeekSkipLast
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- WeekSkipFirst
- WeekSkipLast
- Years
- WireSchedId
- An identifier provided for the reoccurring schedule.
- WireSchedNextDt
- The next scheduled transfer date.
- WireSchedStat
- Identifies the status of the future transfer schedule. Canonical
values are:
- Active
- Expired
- Suspended
WireInvstgModRs_MType
WireInvstgModRs_MType
is a message MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message:
- RsStat
The status of the response. Canonical values are:
- fail
- success
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 submitted message. A
financial institution entity uses the routing transit or ABA nine-digit number
assigned to financial institutions for the purpose of 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 uses a mutually
agreed upon identification that must contain at least one non-integer character.
When a record is directed to a specific financial institution within a holding
company, the institution routing identification is the specific financial
institution routing identification and not the holding company identification.
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 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.