Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

NSF History Search

Enterprise SOAP API > API by Reference > Core Services > NSF History Search

NSF History Search

NSF History Search is a jXchange service designed to allow the consumer to retrieve NSF information for a specific date or range of dates.

Message Flow

In jXchange, the NSF History Search service uses a typical exchange of MType messages to retrieve NSF information for a specific date or range of dates to a service provider.

Primary Request

The third-party consumer forwards the NSFHistSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • BrCode
  • ChkNumEnd
  • ChkNumStart
  • EndDt
  • HighAmt
  • LowAmt
  • NSFStat
  • OffCode
  • StartDt
  • UnResolveOnly

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

The message contains the following array:

  • IncXtendElemArray_AType

Primary Response

The service provider returns the NSFHistSrchRs_MType message to the third-party consumer.

The message contains the following simple elements:

  • BrCode
  • ChkNumEnd
  • ChkNumStart
  • EndDt
  • FeeTotAmt
  • HighAmt
  • LowAmt
  • NSFStat
  • OffCode
  • StartDt
  • UnResolveOnly

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRsHdr_CType

The message contains the following array:

  • NSFHistSrchRecArray_AType

NSF History Search Behavior

The NSF History Search provides consumers with a listing of items that are or were in an insufficient state when presented for payment against the account/draft. The NSF status returned at the initiation of the message represents the status at that point in time. For example, an item might have appeared in the message as an Overdraft, OD, but a subsequent inquiry could return an NSF status of Returned, Ret.

The AccountId_CType is required on the request.

The request provides the consumer a means to filter for specific NSF Account/Draft items.

A consumer request with an effective StartDt and without an EndDt returns all of the qualified NSF items with a date equal to and greater than the start date. All of the other filters must be considered for the response.

A consumer request with an EndDt but without a StartDt returns all of the qualified NSF items with a date equal to and less than the end date. All of the other filters must be considered for the response.

The same principles apply to the LowAmt and HighAmt as with the start and end dates.

The filter for NSF status provides a means for the consumer to filter for specifically different states of transactions. The absence of this element conveys to the service provider to return all NSF status types.

The value provided for the NSFFeeAmt does not necessarily equate to a hard charge to the account. The subsequent element NSFChgWav provides the behavior. The default value is charge.

The PostDt and Amt are required elements contained within the NSFHistSrchRecArray.

NSF History Search Business Case

The consumer is attempting to search NSF history in this business case.

The Third Party Consumer sends the NSFHistSrchRq_MType message with the following values:

Complex ElementSimple ElementEntry Value
AccountIdAcctId775543258999
 AcctTypeD
 NSFStatRet
 StartDt2009-01-01
 EndDt2009-12-31

The Service Provider returns NSFHistSrchRs_MType with the following values:

Complex ElementSimple ElementEntry Value
AccountIdAcctId775543258999
 AcctTypeD
NSFHistSrcRecArray_AType  
NSFHistSrchRec_CTypeNSFStatRet
 PostDt2009-02-28
 Amt500.00
 ChkNum325
 NSFFeeAmt20.00

NSFHistSrchRq_MType

NSFHistSrchRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • IncXtendElemArray_AType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

This is a documented filter statement. Any or all of the following can be sent.

BrCode
The branch code.
ChkNumEnd
The numbers or characters that designate an ending point for check number selections.
ChkNumStart
The numbers or characters that designate a starting point for check number selections.
EndDt
The date that designates the ending point for date selections.
HighAmt
The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
LowAmt
The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
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.
StartDt
The date that designates the starting point for date selections.
UnResolveOnly
A filter used for exception processing inclusion or exclusion of unresolved items. Canonical values are:
  • false
  • true

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element. This is an array that lists x_ elements by name, which are to be included in the response.

Contains:

  • IncXtendElemInfo_CType

IncXtendElemInfo_CType

IncXtendElemInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XtendElem
Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MaxRec
The maximum number of records when multiple records are returned.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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.

NSFHistSrchRs_MType

NSFHistSrchRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • NSFHistSrchRecArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

BrCode
The branch code.
ChkNumEnd
The numbers or characters that designate an ending point for check number selections.
ChkNumStart
The numbers or characters that designate a starting point for check number selections.
EndDt
The date that designates the ending point for date selections.
FeeTotAmt
The total amount of fees assessed that represents all NSF/OD/UCF fees applied to an account for the business day.
HighAmt
The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
LowAmt
The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
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.
StartDt
The date that designates the starting point for date selections.
UnResolveOnly
A filter used for exception processing inclusion or exclusion of unresolved items. Canonical values are:
  • false
  • true

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

NSFHistSrchRecArray_AType

NSFHistSrchRecArray_AType is an array AType element. This is an array of responses for an NSF history search.

Contains:

  • NSFHistSrchRec_CType

NSFHistSrchRec_CType

NSFHistSrchRec_CType is a complex CType element.

Contains:

  • AccountId_CType
  • CustomNSFHistSrchRec
  • EftDescArray_AType
  • x_ACHHistSrchRec_CType
  • x_EFTCardHistSrchRec_CType
Simple Elements

The following simple elements are contained within this complex.

Amt
The amount or quantity.
BrCode
The branch code.
BrDesc
A description of the branch name. It includes the Rstr attribute.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
ComName
The common name. This is the full text line name like John Doe.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
ExcDispCode
The code for an account exception item that conveys the disposition of the item.
ExcDispDesc
The description of 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
ImgNum
The numbers or characters that identify the key of the transaction's stored image.
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
NSFFeeAmt
The NSF fee amount.
NSFItemId
The identification provided to a specific NSF item.
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.
RetRsnCode
The code that describes the reason an account/draft item was returned.
RetRsnDesc
The description of the code that describes the reason an account/draft item was returned.
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.
TrnAuthBalType

This transaction was authorized based on good funds?

  • true
  • false
AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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
CustomNSFHistSrchRec

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.
x_ACHHistSrchRec_CType

x_ACHHistSrchRec_CType is a complex CType element.

Contains:

  • ACHHistSrchRec_CType
  • Custom_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_CType
  • EFTCardHistSrchRec_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_AType
  • Rmk_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.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MoreRec
Indicates if there are more records that could be returned. Canonical values are:
  • false
  • true
SentRec
The number of records sent in the response.
TotRec
Indicates the total records the request selected, which could be larger than MaxRec.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package 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.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Oct 2 2023