Fed Wire Return Response ISO Reply
Fed Wire Return Response ISO Reply
The Fed Wire Return Response ISO Reply service
(FedWireRetRsISOReply) allows consumers to reply on the FedLine® system.
Message Flow
In jXchange, the Fed Wire Return Response ISO Reply service uses a typical
exchange of MType messages
to reply on the FedLine® system.
Primary Request
The consumer forwards the FedWireRetRsISOReplyRq_MType
message to the service provider.
The message contains the following simple elements:
- IMAD
- OrignFinInstRtId
- RetRqMsgId
- RetRqStat
- TrnAcptTimeDt
The message contains the following complex elements:
Custom_CTypeFedLineHdr_CTypeMsgRqHdr_CTypeOrigTrnInfo_CTypeRetRsInfo_CType
The message contains the following arrays:
CancelRsInfoArray_AType
Primary Response
The service provider returns the FedWireRetRsISOReplyRs_MType
message to the consumer.
The message contains the following simple element:
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
FedWireRetRsISOReplyRq_MType
FedWireRetRsISOReplyRq_MType is a
message MType element.
Contains:
CancelRsInfoArray_ATypeCustom_CTypeFedLineHdr_CTypeMsgRqHdr_CTypeOrigTrnInfo_CTypeRetRsInfo_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.
- OMAD
- The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire message during processing and transmission.
- OrignFinInstRtId
- 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.
- RetRqMsgId
- An identification provided by the logging consumer product that defines the message.
- RetRqStat
- The status of a request to return a wire. Canonical values are:
- Apprv
- PartApprv
- Pend
- Rej
- TrnAcptTimeDt
- The date and time a transaction was accepted.
CancelRsInfoArray_AType
CancelRsInfoArray_AType is an array
AType element. This element is an array of cancellation reasons specific to
wires.
Contains:
CancelRsInfo_CType
CancelRsInfo_CType
CancelRsInfo_CType is
a complex CType element.
Contains:
AddrISO_CTypeCancelRsRmkArray_ATypereferencesRmk_ATypeCustom_CTypeInstEntityInfoArray_ATypePersonIdInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- CancelRsId
- An identifier given to the response to a cancel request.
- CancelRsRsnDesc
- The description of the status of the response to return a wire.
- CancelRsRsnType
- The status of the response to return a wire. Canonical values
are:
- AcctCls
- AgentDiscr
- InvalidSeq
- Misc
- MissingOrigTrn
- NoCustRs
- NSF
- PendCustAuth
- PendCustRs
- PendLegal
- PendReply
- RetProc
- RqDrAuth
- TrfAgent
- InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstEntityIssr
- A free-form description of the issuer of the identification.
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- Name
- The common name. This element is the full text line name like John Doe.
- ResCntryType
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
CancelRsRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
CancelRsRmkArray 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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InstEntityInfoArray_AType
InstEntityInfoArray_AType is a complex AType element. This element is an
array of institution entity information as related to a wire transaction.
Contains:
InstEntityRec_CType
InstEntityRec_CType
InstEntityRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- InstEntityDesc
- A free-form description as the type of entity.
- InstEntityId
- The identification given to an entity.
- InstEntityIssr
- A free-form description of the issuer of the identification.
- InstEntitySeqId
- The identification given to an entity.
- InstEntityType
Identifies the different types of entities. A hybrid enumerated element with a preset list of values. Canonical values are:
- BankId
- BusDomId
- CentralBankId
- CertifCorpId
- ClearingId
- CntryId
- CustId
- DataUnivId
- EmplId
- GlobLocId
- OthBusId
- SREN
- SRET
- TaxId
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PersonIdInfo_CType
PersonIdInfo_CType is a complex CType element.
Contains:
Custom_CTypeIdArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BirthCity
- The city name.
- BirthCntryType
- The country abbreviation from ISO 3166.
- BirthDt
- The date of birth.
- BirthStateProv
- The state, province, or region.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IdArray_AType
IdArray_AType is an
array AType element. This element is an array of identifications specific to a
person.
Contains:
IdRec_CType
IdRec_CType
IdRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- IdDesc
- Free-form identification description.
- IdIssuer
- The named issuer of identification.
- IdSeqId
- The sequence identifier given to an identifier used for identify a person.
- IdType
- Identifications as related to ISO formats. This element is
hybrid-enumerated with a preset list of values. Canonical values are:
- DriverLic
- Passport
- ResidentAlienId
- EmplId
- NatIdNum
- TaxId
- SSN
- CustId
- IdVal
- The identification value.
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.
FedLineHdr_CType
FedLineHdr_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- FinInstRtId
- The financial institution's routing and transit identification.
- LTermId
- An identification provided to a logical terminal that is unique within a financial institution.
- UsrCorrelId
- An identification provided by a consumer's application to correlate messages with the FRB.
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 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.
OrigTrnInfo_CType
OrigTrnInfo_CType is
a complex CType element.
Contains:
Custom_CTypeWireFinInstInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- IMAD
- The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire message during processing and transmission.
- InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstEntityDesc
- A free-form description as the type of entity.
- InstEntityId
- The identification given to an entity.
- InstEntityIssr
- A free-form description of the issuer of the identification.
- InstEntityType
Identifies the different types of entities. A hybrid enumerated element with a preset list of values. Canonical values are:
- BankId
- BusDomId
- CentralBankId
- CertifCorpId
- ClearingId
- CntryId
- CustId
- DataUnivId
- EmplId
- GlobLocId
- OthBusId
- SREN
- SRET
- TaxId
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- WireAmt
- The transactional amount of the wire transfer.
- WireCrtTimeDt
- The time and date the wire transaction was created.
- WireCurrType
- The alphanumeric ISO 4217 currency code.
- WireInstrId
- 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.
- WireInstrTrnId
- Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.
- WireRefId
- The wire reference identification provided to a transaction.
- WireSttlTimeDt
- The time and date the wire transaction was settled.
- WireUETR
- A universally unique identifier to provide an end-to-end reference.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireFinInstInfo_CType
WireFinInstInfo_CType is a complex
CType element.
Contains:
AddrISO_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- FinInstName
- The depository financial institution name. The
SrchTypeattribute is optional. - InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- 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.
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RetRsInfo_CType
RetRsInfo_CType is a
complex CType element.
Contains:
AddrISO_CTypeCustom_CTypeInstEntityInfoArray_ATypePersonIdInfo_CTypeWireFinInstInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- EntityName
- The common name. This is the full text line name like John Doe.
- InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- MsgId
- An identification provided by the logging consumer product that defines the message.
- ResCntryType
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InstEntityInfoArray_AType
InstEntityInfoArray_AType is a complex AType element. This element is an
array of institution entity information as related to a wire transaction.
Contains:
InstEntityRec_CType
InstEntityRec_CType
InstEntityRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- InstEntityDesc
- A free-form description as the type of entity.
- InstEntityId
- The identification given to an entity.
- InstEntityIssr
- A free-form description of the issuer of the identification.
- InstEntitySeqId
- The identification given to an entity.
- InstEntityType
Identifies the different types of entities. A hybrid enumerated element with a preset list of values. Canonical values are:
- BankId
- BusDomId
- CentralBankId
- CertifCorpId
- ClearingId
- CntryId
- CustId
- DataUnivId
- EmplId
- GlobLocId
- OthBusId
- SREN
- SRET
- TaxId
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PersonIdInfo_CType
PersonIdInfo_CType is a complex CType element.
Contains:
Custom_CTypeIdArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BirthCity
- The city name.
- BirthCntryType
- The country abbreviation from ISO 3166.
- BirthDt
- The date of birth.
- BirthStateProv
- The state, province, or region.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IdArray_AType
IdArray_AType is an
array AType element. This element is an array of identifications specific to a
person.
Contains:
IdRec_CType
IdRec_CType
IdRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- IdDesc
- Free-form identification description.
- IdIssuer
- The named issuer of identification.
- IdSeqId
- The sequence identifier given to an identifier used for identify a person.
- IdType
- Identifications as related to ISO formats. This element is
hybrid-enumerated with a preset list of values. Canonical values are:
- DriverLic
- Passport
- ResidentAlienId
- EmplId
- NatIdNum
- TaxId
- SSN
- CustId
- IdVal
- The identification value.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireFinInstInfo_CType
WireFinInstInfo_CType is a complex
CType element.
Contains:
AddrISO_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- FinInstName
- The depository financial institution name. The
SrchTypeattribute is optional. - InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- 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.
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
FedWireRetRsISOReplyRs_MType
FedWireRetRsISOReplyRs_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 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 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.