International Wire Transaction Addition
International Wire Transaction Addition
International Wire Transaction Addition is a jXchange service designed to allow consumers to submit an international wire.
Message Flow
In jXchange, the International Wire Transaction Addition service uses a typical
exchange of MType messages
to allow consumers to submit an international wire.
Primary Request
The consumer forwards the IntlWireTrnAddRq_MType message to
the service provider.
This message contains the following simple elements:
- AvlBalCalcCode
- FundMthdType
- IntnetFinInstId
- WireAcctId
- WireAcctType
- WireContrRefId
- WireCorrelId
- WireQuoteId
- WireUsrId
This message contains the following complex elements:
Custom_CTypeMsgRqHdr_CTypeWireIntlCustInfoRec_CTypeWireIntlQuoteRec_CTypeWireIntlTrnInfoRec_CType
This message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the IntlWireTrnAddRs_MType message to
the consumer.
The message contains the following simple elements:
- CurrExchRate
- FornCurrAmt
- RsStat
- SttlCostAmt
- TrnRcptId
- WireBankFeeAmt
- WireBankTaxAmt
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
International Wire Transaction Addition Behavior
The International Wire Transaction Addition service behavior is as follows.
The International Wire Transaction Addition root request message
(IntlWireTrnAddRq_MType) requires the following elements:
- Wire Correlation Identifier (WireCorrelId)
- Wire Account Identifier (WireAcctId)
- Wire International Customer Information Record
(
WireIntlCustInfoRec_CType) - Wire International Transaction Information Record
(
WireIntlTrnInfoRec_CType)
There must be a valid quote and/or contract reference identifier provided by the international wire provider.
The International Wire Transaction Addition root request message
(IntlWireTrnAddRq_MType) optionally allows for the following
elements:
- Available Balance Calculation Code (AvlBalCalcCode)
- Funding Method Type (FundMthdType)
- Internet Financial Institution Identifier (IntnetFinInstId)
- Wire Account Type (WireAcctType)
- Wire Contract Reference Identifier (WireContrRefId)
- Wire International Quote Record (
WireIntlQuoteRec_CType) - Wire Quote Identifier (WireQuoteId)
- Wire User Identifier (WireUsrId)
The Wire International Quote Record (WireIntlQuoteRec_CType) complex
contains the following elements:
- Currency Exchange Rate (CurrExchRate)
- Current Payment Type (CurrPmtType)
- Fee Currency Type (FeeCurrType)
- Foreign Currency Amount (FornCurrAmt)
- Settlement Cost Amount (SttlCostAmt)
- Settlement Net Cost Amount (SttlNetCostAmt)
- Total Fee Amount (TotFeeAmt)
- Wire Bank Fee Amount (WireBankFeeAmt)
- Wire Bank Tax Amount (WireBankTaxAmt)
- Wire Transaction Time/Date (WireTrnTimeDt)
The Wire International Customer Information record
(WireIntlCustInforRec_CType) complex identifies the international
wire customer and contains the following elements:
- Customer Identifier (CustId)
- Customer Type (CustType)
- Identification Verification Code (IdVerifyCode)
- Identification Verification Value (IdVerifyVal)
- Tax Identifier (TaxId)
- Wire Contact Array (
WireConArray_AType) - Wire Customer Information (
WireCustInfo_CType) - Wire Information Remark Array (
WireInfoRmkArray_AType)
The Wire Customer Information (WireCustInfo_CType) contains demographic
information (i.e., Name, Address, Phone numbers) specifically for a non-customer.
The Customer Identifier (CustId) and Wire Customer
Information (WireCustInfo_CType) are part of a documented choice
statement where both are optional but at least one must be provided.
The Wire International Transaction Information Record
(WireIntlTrnInfoRec_CType) complex identifies the transactional
aspect of the international wire and contains the following elements:
- Country (Cntry)
- Currency Type (CurrType)
- Wire Amount (WireAmt)
- Wire International Beneficiary Information Record
(
WireIntlBenfInfoRec_CType) - Wire Notification Type (WireNotType)
- Wire Origination To Beneficiary Information Record
(
WireOrignToBenfInfoRec_CType) - Wire Receiving Financial Institution Remark Array
(
WireRecvFinInstRmkArray_AType) - Wire Source (WireSrc)
The Wire International Beneficiary Information Record
(WireIntlBenfInfoRec_CType) complex identifies the international
wire beneficiary and contains the following elements:
- Wire Beneficiary Email Array
(
WireBenfEmailArray_AType) - Wire Beneficiary Address (
WireBenfAddr_CType) - Wire Beneficiary Financial Institution Address
(
WireBenfFinInstAddr_CType) - Wire Beneficiary Financial Institution Identifier (WireBenfFinInstId)
- Wire Beneficiary Financial Institution Name
(
WireBenfFinInstName) - Wire Beneficiary Identifier (WireBenfId)
- Wire Beneficiary Identifier Type (WireBenfIdType)
- Wire Beneficiary Name (WireBenfName)
- Wire Beneficiary Reference (WireBenfRef)
The International Wire Transaction Addition root response
(IntlWireTrnAddRs_MType) returns the following elements:
- Currency Exchange Rate (CurrExchRate)
- Foreign Currency Amount (FornCurrAmt)
- Response Status (RsStat)
- Settlement Cost Amount (SttlCostAmt)
- Transaction Receipt Identifier (TrnRcptId)
- Wire Bank Fee Amount (WireBankFeeAmt)
- Wire Bank Tax Amount (WireBankTaxAmt)
The standard Addition message tenets apply.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
IntlWireTrnAddRq_MType
IntlWireTrnAddRq_MType is a message MType element.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CTypeWireIntlCustInfoRec_CTypeWireIntlQuoteRec_CTypeWireIntlTrnInfoRec_CType
Simple Elements
The following simple elements are contained within this message.
- AvlBalCalcCode
- A code that conveys to the service provider the method to use for the calculation of the available balance.
- FraudRefId
- A unique identification provided by the fraud risk application when a request for review is submitted.
- FundMthdType
The method of the fund transfer. Canonical values are:
- Draft
- IncomingWire
- IntraContr
- OutgoingWire
The default is OutgoingWire.
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- WireAcctId
- The account identification related to wires.
- WireAcctType
- The number or character that categorizes the AcctId.
- 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.
- WireContrRefId
- The wire contract reference identification assigned by the wire provider.
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WireQuoteId
- The quote identification given by a wire provider.
- WireUsrId
- The applications' user identification for the transactional activity.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_CType
Simple Elements
The following simple elements are contained within this complex.
- AuthenProdCred
- Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType
AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in
the form of a WS Security element that contains a single SAML V2.0
Assertion.
Simple Elements
The following simple elements are contained within this complex.
- Security
- Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.- BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The 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.
WireIntlCustInfoRec_CType
WireIntlCustInfoRec_CType is a complex CType element.
Contains:
Custom_CTypeWireConArray_ATypeWireCustInfo_CTypeWireInfoRmkArrayreferencesRmk_ATypeWireInternalRmkArrayreferencesRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- CustType
- The customer type. Examples include business or individual.
Canonical values are:
- Bus
- Indv
- IdVerifyCode
- The identification code that is used to authenticate the customer.
- IdVerifyVal
- The identification value that is used to authenticate the customer.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireConArray_AType
WireConArray_AType is an array AType element. This is an array of
contacts for a wire transaction.
Contains:
WireConInfo_CType
WireConInfo_CType
WireConInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireCustInfo_CType
WireCustInfo_CType is a complex CType element.
Contains:
Addr_CTypeCustom_CTypePersonName_CTypePhoneArray_AType
Addr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
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.
PhoneArray_AType
PhoneArray_AType is an array AType
element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
PersonName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This element is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
WireInternalRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireInternalRmkArray 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.
WireInfoRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireInfoRmkArray 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.
WireIntlQuoteRec_CType
WireIntlQuoteRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this message.
- CurrExchRate
- The exchange rate for a specific currency.
- CurrPmtType
- The type that designates the currency represented for the wire
amount. Canonical values are:
- Forn
- Local
- FeeCurrType
- The alphanumeric ISO 4217 currency code.
- FornCurrAmt
- The foreign currency amount.
- SttlCostAmt
- The cost to the client in the settlement currency for performing transactions.
- SttlNetCostAmt
- The net cost to the client in the settlement currency for performing transactions.
- TotFeeAmt
- The amount of fees.
- WireBankFeeAmt
- The other bank fees mandatory for client notification.
- WireBankTaxAmt
- The other bank taxes mandatory for client notification.
- WireTrnTimeDt
- The time and date of the wire transaction.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireIntlTrnInfoRec_CType
WireIntlQuoteRec_CType is a complex CType element.
Contains:
Custom_CTypeWireIntlBenfInfoRec_CTypeWireOrignToBenfInfoRec_CTypeWireRecvFinInstRmkArrayreferencesRmk_AType
Simple Elements
The following simple elements are contained within this message.
- Cntry
- The country name.
- CurrType
- The alphanumeric ISO 4217 currency code.
- WireAmt
- The transactional amount of the wire transfer.
- 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
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireIntlBenfInfoRec_CType
WireIntlBenfInfoRec_CType is a complex CType element.
Contains:
Custom_CTypeWireBenfAddrreferencesAddr_CTypeWireBenfEmailArrayreferencesEmailArray_ATypeWireBenfFinInstAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- WireBenfId
- The identifier associated with the Wire Beneficiary ID element.
- WireBenfIdType
- Identifies the type of beneficiary identification. Canonical values
are:
- Bank
- CHIPSId
- CHIPSPart
- CorpId
- DepAcct
- DriverLic
- Fed
- Oth
- PassPort
- ResidenceCard
- SwiftId
- TaxId
- WireBenfName
- The named beneficiary for a wire transaction.
- WireBenfFinInstId
- The identification of the beneficiary-named financial institution for a wire transfer.
- WireBenfFinInstName
- The name of the beneficiary-named financial institution for a wire transfer.
- WireBenfRef
- Provides reference information for use by the beneficiary to identify the transfer.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireBenfAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireBenfAddr references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
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.
WireBenfEmailArray
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
WireBenfEmailArray
references EmailArray_ATypeContains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype is a complex
CType element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
WireBenfFinInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireBenfFinInstAddr references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
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.
WireOrignToBenfInfoRec_CType
WireOrignToBenfInfoRec_CType is a
complex CType element.
Contains:
Custom_CTypeWireOrignToBenfRmkArrayreferencesRmk_AType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireOrignToBenfRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireOrignToBenfRmkArray 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.
WireRecvFinInstRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireRecvFinInstRmkArray 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.
IntlWireTrnAddRs_MType
IntlWireTrnAddRs_MType is a message MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CurrExchRate
- The exchange rate for a specific currency.
- FornCurrAmt
- The foreign currency amount.
- RsStat
The status of the response. Canonical values are:
- fail
- success
- SttlCostAmt
- The cost to the client in the settlement currency for performing transactions.
- TrnRcptId
- The receipt provided for a successful transaction entry.
- WireBankFeeAmt
- The other bank fees mandatory for client notification.
- WireBankTaxAmt
- The other bank taxes mandatory for client notification.
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.