Account NSF Transaction Inquiry
Account NSF Transaction Inquiry
Account NSF Transaction Inquiry is a jXchange service designed to retrieve the details of an account's NSF transaction.
Message Flow
In jXchange, the Account NSF Transaction Inquiry service uses a typical exchange of
MType messages to return element details related to an account's NSF
transaction.
Primary Request
The consumer forwards the AcctNSFTrnInqRq_MType message to
the service provider.
The message contains the following simple elements:
- ActIntent
- NSFItemID
The message contains the following complex elements:
Custom_CTypeInAcctIdreferencesAccountId_CTypeMsgRqHdr_CType
The message contains the following array:
IncXtendElem_AType
Primary Response
The service provider returns the AcctNSFTrnInqRs_MType
message to the consumer.
The message contains the following simple elements:
- ActIntent
- FeeTotAmt
- NSFItemId
The message contains the following complex elements:
Custom_CTypeInAcctIdreferencesAccountId_CTypeMsgRsHdr_CType
The message contains the following array:
AcctNSFTrnRecArray_AType
Account NSF Transaction Inquiry Behavior
The Account NSF Transaction Inquiry behavior is as follows.
The AcctNSFTrnInqRq_MType request
message requires a valid AcctId simple element. The NSFItemId simple element can be
included if the consumer prefers to have only one NSF item returned. A request with the
NSFItemId simple
element conveys to the service provider to return only the NSF transactions that require
processing from the previous and/or current financial institution's business day. The
transactions depend on the service provider's NSF processing application architecture.
The Account NSF Transaction Inquiry service was constructed in a way that allows for a modification service.
The AcctNSFTrnInqRq_MType request message contains the IncXtendElemArray_AType array, which
allows the consumer to request the ACH History related to the account NSF item. The x_ACHHistSrchRec_CType record
extended complex returns only if requested in the AcctNSFTrnInqRq_MType request
message.
The ActIntent simple element is included optionally in the request message in
accordance with the guidelines established for concurrency processing. The ActIntent simple element is
applied to all the NSF items returned in the AcctNSFTrnInqRs_MType response
message.
The AcctNSFTrnInqRs_MType response message returns the ActIntentKey simple element for
each NSF item when the ActIntent simple element is submitted with a ~Upd~ or ~Dlt~ data value. The service
provider must return a unique ActIntentKey simple element for each NSF item. The default value is ReadOnly. The consumer caches the
ActIntentKey simple
element so it can be submitted in a subsequent modification request.
The Account NSF Transaction Inquiry response message
(AcctNSFTrnInqRs_MType), which contains the Account NSF Transaction Record
Info complex (AcctNSFTrnRecInfo_CType), was updated to include the extended
optional object Extended EFT Card History Search Record
(x_EFTCardHistSrchRec_CType).
AcctNSFTrnInqRq_MType
AcctNSFTrnInqRq_MType is a message
MType element.
Contains:
Custom_CTypeInAcctIdreferencesAccountId_CTypeIncXtendElem_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- NSFItemId
- The identification provided to a specific NSF item.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
InAcctId references
AccountId_CType.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child
node. Canonical values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
IncXtendElemArray_AType
IncXtendElemArray_AType is an array AType element. This is an array that
lists x_ elements by name, which are to be included in the response.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
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.
AcctNSFTrnInqRs_MType
AcctNSFTrnInqRs_MType is a message
MType element.
Contains:
AcctNSFTrnRecArray_ATypeCustom_CTypeInAcctIdreferencesAccountId_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- FeeTotAmt
- The total amount of fees assessed that represents all NSF/OD/UCF fees applied to an account for the business day.
- NSFItemId
- The identification provided to a specific NSF item.
AcctNSFTrnRecArray_AType
AcctNSFTrnRecArray_AType is an array
AType element. This is an array of account NSF items.
Contains:
AcctNSFTrnRecInfo_CType
AcctNSFTrnRecInfo_CType
AcctNSFTrnRecInfo_CType is a complex
CType element.
Contains:
Custom_CTypeEftDescArray_ATypeNSFItemTrnRec_CTypeTrnAuthBalDetRec_CTypex_ACHHistSrchRec_CTypex_EFTCardHistSrchRec_CType
Simple Elements
The following simple elements are contained within this complex.
- ActIntentKey
- The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
- Amt
- The amount or quantity.
- BatchNum
- The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
- ChgWavOffDesc
- The NSF charge waived officer short name.
- ChkNum
- The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
- ChngTime
- Indicates that time changes were made.
- EffDt
- The date assigned to transactions when it is different from the posting date.
- ExcActnDesc
- The description of the code for an account exception item that conveys the action that was taken to the item.
- ExcAuditWsId
- 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.
- ExcDispDesc
- The description of the code for an account exception item that conveys the disposition of the item.
- ExcRetRsnDesc
- The description of the code for an account exception item that conveys the reason the item was returned.
- ExcUsrId
- 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.
- ImgNum
- The numbers or characters that identify the key of the transaction's stored image.
- NSFAutoWorkExcDesc
- The exception reason that an NSF item could not be automatically worked without user intervention.
- NSFChgWav
- A list of values that designate the behavior for charging or waving
accounts/drafts in an insufficient state. Canonical values are:
- Chg
- NA
- Wav
- NSFChgWavRsnDesc
- The description of the code of the reason an NSF charge was waived.
- NSFFeeAdjAmt
- The amount of the NSF fee that was adjusted.
- NSFFeeAmt
- The NSF fee amount.
- NSFItemId
- The identification provided to a specific NSF item.
- NSFODType
- The OD situation for an NSF item at the time of item presentment.
Canonical values are:
- NA
- Pd
- Prst
- PrstPd
- NSFPdUnCol
- Answers the question: Was the NSF item paid against uncollected
funds? Canonical values are:
- false
- true
- NSFStat
- The status of an item that required additional handling due to
account/draft boundaries. Canonical values are:
- OD
- Paid
- Ret
- Susp
- OffCode
- The code that designates the financial institution officer.
- OffDesc
- The officer short name.
- PostDt
- The date a transaction has posted or is scheduled to be posted to an account.
- SeqNum
- The integer assigned to a specific transaction.
- TrnAuthBalType
This transaction was authorized based on good funds?
truefalse
- TrnAuthExcRsnCode
- The code that describes the reason for the exception.
- TrnAuthExcRsnDesc
- The code that describes the reason for the exception.
- TrnCodeCode
- The code that identifies the behavior of a monetary transaction.
- TrnCodeDesc
- The description of the code that identifies the behavior of a monetary transaction.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTDescArray_AType
EFTDescArray_AType is an array
AType element.
Contains:
EftDescInfo_CType
EftDescInfo_CType
EftDescInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EftDesc
- A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.
NSFItemTrnRec_CType
NSFItemTrnRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ChgWavOffCode
- The code that designates the financial institution officer.
- ExcActnCode
- The code for an account exception item that conveys the action that was taken to the item.
- ExcDispCode
- The code for an account exception item that conveys the disposition of the item.
- ExcResolveType
- Answers the question: Should the account exception item be
considered resolved? Canonical values are:
- False
- True
- ExcRetRsnCode
- The code for an account exception item that conveys the reason the item was returned.
- NSFChgWavRmk
- Application or user remarks free-form text.
- NSFChgWavRsnCode
- The code of the reason an NSF charge was waived.
TrnAuthBalDetRec_CType
TrnAuthBalDetRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Dictionary
- AccrInt
- The accrued interest.
- AvlBal
- The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
- BnceProtAmt
- The amount of funds set aside to protect an account from creating NSF items.
- ColBal
- The collected balance.
- CurBal
- The current balance.
- FltAmt
- The amount of float outstanding against this account.
- HldAmt
- The hold amount.
- InvestAcctCrAmt
- The total credit out of FI investment transfer system available amount on a given business day.
- InvestAcctDrAmt
- The total debit out of FI investment transfer system available amount on a given business day.
- NetMemoPostAmt
- The sum of the current memo-posted items against this account.
- ODLmt
- The overdraft limit.
- ODProtAmt
- The amount of overdraft protection (credit line) this account has.
- SweepAvlCrAmt
- The total credit sweep transfer system available amount on a given business day.
- SweepAvlDrAmt
- The total debit sweep transfer system available amount on a given business day.
- TrnAuthBalTimeDt
- The time and date the transaction was authorized on good funds.
- YestBal
- Yesterday's balance.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
x_ACHHistSrchRec_CType
x_ACHHistSrchRec_CType is a complex
CType element.
Contains:
ACHHistSrchRec_CTypeCustom_CType
ACHHistSrchRec_CType
ACHHistSrchRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ACHCompName
- The ACH company name, as governed by Nacha® rules.
- ACHCompDiscrData
- The ACH company discretionary data, as governed by Nacha® rules.
- ACHCompDtDesc
- A date created by the ACH originator for descriptive purposes and never used for any timing controls.
- ACHCompEntryDesc
- The ACH company entry description, as governed by Nacha® rules.
- ACHCompId
- The ACH company ID.
- ACHDtSttl
- The date on which the ACH participating financial institution is scheduled to be debited or credited FRB. This is not of type date due to the format of the date governed by Fed.
- ACHEffDt
- The date assigned to transactions when it is different from the posting date.
- ACHIndvDiscrData
- The ACH individual discretionary data as governed by Nacha® rules.
- ACHIndvId
- The ID entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
- ACHIndvName
- The name entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
- ACHRetRsnCode
- The Nacha® governed standard return reason codes to describe the reason for returning an ACH entry.
- ACHRetRsnDesc
- The Nacha® governed standard return reason codes to describe the reason for returning an ACH entry.
- ACHStdEntryClass
- The ACH standard entry class.
- ACHSvcClass
- The general classification of dollar entries for ACH exchange as governed by Nacha®.
- ACHTraceId
- The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.
- ACHTraceNum
- The ACH trace number that uniquely identifies each entry detail
record within a batch in an ACH file.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2018–01–01.
- ACHTrnCode
- The transaction code to be used for the ACH item, as governed by Nacha® rules.
- ACHTrnDesc
- The description of the transaction code to be used for the ACH item, as governed by Nacha® rules.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
x_EFTCardHistSrchRec_CType
x_EFTCardHistSrchRec_CType is a complex
CType element.
Contains:
Custom_CTypeEFTCardHistSrchRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardHistSrchRec_CType
EFTCardHistSrchRec_CType is a
complex CType
element.
Contains:
EFTDescArray_ATypeRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- AddrVerifCode
- The code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifDesc
- The description of the code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifText
- Any textual values provided by the transaction initiator regarding the address verification.
- AppTrnGenr
- Answers the question: Did the EFT transaction application provider
generate a transaction? Canonical values are:
- false
- true
- ATMTrnSttlType
- Answers the question: Was the EFT transaction settled at the time
of the initiated transaction? Canonical values are:
- false
- true
- CashDistrType
- Answers the question: Was cash distributed/dispensed for the EFT
transaction? Canonical values are:
- false
- true
- EFTAtUsATMType
- Answers the question: Was the EFT transaction initiated by one of the
financial institution's ATM terminals? Canonical values are:
- false
- true
- EFTCardCapType
- Answers the question: What process was used to capture the EFT card
data? Canonical values are:
- BarCode
- CertMagRead
- ChipRead
- ElecMer
- Keyed
- MagRead
- OCR
- Trak
- UnCertChipRead
- EFTCardExpDt
- The expiration date given to an EFT card.
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardSufxNum
- The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
- EFTCashTrnRqAmt
- The cash transaction amount requested by the card holder.
- EFTExcAmt
- The amount of the transaction that is not accepted and is considered an exception.
- EFTNtwkId
- The identification that defines the network for the original acquirer of the transaction.
- EFTOnUsTrnType
- Answers the question: Was the EFT transaction initiated by the
financial institution's account holder? Canonical values are:
- false
- true
- EFTPrvdApprvBalAmt
- The balance that was used by the EFT card processor for transaction approval when the application provider was not available.
- EFTPrvdApprvTrn
- Answers the question: Was the transaction approved by the EFT card
processor? Canonical values are:
- false
- true
- EFTSwchSeqId
- The identification given to the transaction by the card switch provider.
- EFTSwchTrnDt
- The card switch date of the transaction.
- EFTSwchTrnTime
- The card switch time of the transaction.
- EFTTrnActIdType
- Describes the type of EFT transaction activity identification.
Canonical values are:
- ForcePost
- Rev
- Rq
- EFTTrnAmt
- The actual amount of the transaction accepted by the provider.
- EFTTrnAuthBalAmt
- The balance that was used for authorization of the EFT transaction.
- EFTTrnCode
- The code that defines the type of EFT transaction.
- EFTTrnCorrelId
- An identification provided by a network to correlate a pre-authorization with the EFT transaction.
- EFTTrnDesc
- The description of the code that defines the type of EFT transaction.
- EFTTrnDt
- The date of the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnRcptBalAmt
- The balance that was printed on the receipt for the EFT transaction.
- EFTTrnRqAmt
- The transaction amount requested by the card holder.
- EFTTrnSeqId
- The identification given to the transaction by the provider.
- EFTTrnStatDesc
- The description of the status of the EFT transaction.
- EFTTrnStatRmk
- Any additional free-form remarks regarding the status of the EFT transaction.
- EFTTrnStat
- The status of the EFT transaction.
- EFTTrnTime
- The time of the transaction.
- EFTXferToAcctId
- The recipient account identification of an EFT transfer transaction.
- EFTXferToAcctType
- The numbers or characters that categorize the
EFTXferToAcctId. - ExcRsnCode
- The code that describes the reason for the exception.
- ExcRsnDesc
- The description of the code that describes the reason for the exception.
- MerName
- The name of the merchant that processed the POS transaction.
- MerPartAuth
- Answers the question: Does the POS merchant support/accept partial
authorizations? Canonical values are:
- false
- true
- PreAuthExpDt
- The expiration date for the pre-authorized transaction.
- PreAuthRemDays
- The number of days remaining for the pre-authorized transaction.
- RecurTrnType
- Identifies a transaction as recurring. Canonical values are:
- false
- true
- SerChgAmt
- The amount of service charge assessed to an account.
- StdIndustCode
- The standard industry code.
- StdIndustDesc
- The standard industry code description.
- SurChgAmt
- The amount of the transaction that is part of the charges for the transactional activity.
- SwchTrnType
- Answers the question: Was the EFT transaction processed through
a switch network? Canonical values are:
- false
- true
- TrnSttlDt
- The date a transaction was settled.
- TrnSttlTime
- The time a transaction was settled.
EFTDescArray_AType
EFTDescArray_AType is an array
AType element.
Contains:
EftDescInfo_CType
EftDescInfo_CType
EftDescInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EftDesc
- A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.
Rmk_AType
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
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.
InAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
InAcctId references
AccountId_CType.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child
node. Canonical values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
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.