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

Account Exception Transaction Search

Enterprise SOAP API > API by Reference > Core Services > Account Exception Transaction Search

Account Exception Transaction Search

Account Exception Transaction Search is a jXchange service designed to return all exceptions related to a specific account, including the NSF items.

Message Flow

In jXchange, the Account Exception Transaction Search service uses a typical exchange of MType messages to return all exceptions related to the specific account listed in the search. The returned items include the NSF items, along with any of the optional filters included in the request.

Primary Request

The Consumer forwards the AcctExcTrnSrchRq_MType message to the Service Provider. The message contains:

  • Custom_CType
  • InAcctId references AccountId_CType - Required
  • SrchMsgRqHdr_CType

Primary Response

The Service Provider returns the AcctExcTrnSrchRs_MType message to the Consumer. The message contains:

  • Custom_CType
  • ExcTrnSrchRecArray_AType
  • InAcctId references AccountId_CType - Required
  • SrchMsgRsHdr_CType

Account Exception Transaction Search Behavior

The Account Exception Transaction Search service returns all exceptions related to a specific account, including the NSF items. It also returns any of the optional filters used in the request.

The InAcctId (AccountId_CType) is required in the request. Data is returned when the InAcctId matches the UpdAcctId and UpdAcctType. Unless they contain no data, in which case the match is made on the original/captured account number.

The ExcRsnCode element and UnResolveOnly element are optional filter elements. The absence of the ExcRsnCode element conveys to the service provider to return all exception types.

Check number range filters are compared to the ChkNum element. A consumer request with a starting ChkNumStart and no end ChkNumEnd, returns all exceptions (that match any other criteria) from that check number up. A request with a ChkNumEnd but no ChkNumStart returns all items up to (and including) that check number. A request with both a ChkNumStart and a ChkNumEnd returns any qualified exceptions equal to those check numbers and all between them.

The date filters use the PostDt element for comparisons.

A consumer request with a StartDt and without an EndDt, returns all the exceptions with a date equal to and greater than the StartDt. A request with an EndDt and without a StartDt, returns all the exceptions with a date less than the EndDt.

The amount range filters LowAmt and HighAmt compare to element Amt. To get records equal to a specific amount only, the desired amount would be sent in both elements.

The response set is returned in last-in-first-out order. The standard search message header tenets are applicable.

The elements in the AcctExcTrnSrchRq_MType request message are echoed in the root response. The response contains ExcRsnRecArray_AType, an array of exception reason codes since an item may be an exception for multiple reasons. The response contains the ExcResolveType element to convey if the item has been resolved with the UnResolveOnly filter in the request.

AcctExcTrnSrchRq_MType

AcctExcTrnSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

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.
ExcRsnCode
The code that describes the reason for the exception.
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.
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

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

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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.

AcctExcTrnSrchRs_MType

AcctExcTrnSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • ExcTrnSrchRecArray_AType
  • InAcctId references AccountId_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

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.
ExcRsnCode
The code that describes the reason for the exception.
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.
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

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ExcTrnSrchRecArray_AType

ExcTrnSrchRecArray_AType is an array AType element. This is an array of responses for the Exception Transactions Search service.

Contains:

  • ExcTrnSrchRec_CType

ExcTrnSrchRec_CType

ExcTrnSrchRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EFTDescArray_AType
  • ExcRsnRecArray_AType
Simple Elements

The following simple elements are contained within this complex.

ACHCompName
The ACH company name, as governed by NACHA rules.
ACHStdEntryClass
The ACH standard entry class.
Amt
The amount or quantity.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
EffDt
The date assigned to transactions when it is different from the posting date.
ExcActnCode
The code for an account exception item that conveys the action that was taken to the item.
ExcActnDesc
The description of 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.
ExcDispDesc
The description of the code for an account exception item that conveys the disposition of the item.
ExcItemId
The identifier assigned to a specific account exception item.
ExcResolveType
Answers the question: Should the account exception item be considered resolved? Canonical values are:
  • false
  • true
NSFItemId
The identification provided to a specific NSF item.
PostDt
The date a transaction has posted or is scheduled to be posted to an account.
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.

ExcRsnRecArray_AType

ExcRsnRecArray_AType is an array AType element. This is an array of item exception reasons.

Contains:

  • ExcRsnRec_CType
ExcRsnRec_CType

ExcRsnRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ExcRsnCode
The code that describes the reason for the exception.
ExcRsnDesc
The description of the code that describes the reason for the exception.
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.

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

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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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 Soap Header Fault 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 Jan 24 2022