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 Inquiry

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

Account Exception Transaction Inquiry

Account Exception Transaction Inquiry is a jXchange service designed to inquire on transactions related to a specific account and a specific exception.

Message Flow

In jXchange, the Account Exception Transaction Inquiry service uses a typical exchange of MType messages to return all exceptions related to the specific AcctId and specific ExcItemId listed in the inquiry.

Primary Request

The consumer forwards the AcctExcTrnInqRq_MType message to the service provider. The message contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • IncXtendElemArray
  • MsgRqHdr_CType

Primary Response

The service provider returns the AcctExcTrnInqRs_MType message to the Consumer. The message contains:

  • Custom_CType
  • ExcRsnRecArray_AType
  • ExcTrnRec_CType
  • InAcctId references AccountId_CType
  • MsgRsHdr_CType
  • x_ACHHistSrchRec_CType

Account Exception Transaction Inquiry Behavior

The AcctExcTrnInqRq_MType request message requires a valid AcctId element and ExcItemId element.

This inquiry message was constructed in a manner that allows for a modification service in the future.

The AcctExcTrnInqRq_MType request message contains the IncXtendElemArray_AType array, which allows the consumer to request the ACH History related to the account exception item. The x_ACHHistSrchRec_CType extended complex only returns if requested in the root request.

The response contains the ExcRsnRecArray_AType, which is an array of exception reason codes, since an item may be an exception for multiple reasons.

The ActIntent element is included optionally in the request in accordance with the guidelines established for concurrency processing.

The AcctExcTrnInqRs_MType response message returns the ActIntentKey element when the ActIntent element is submitted with a Upd or Dlt data value. The default value is ReadOnly. The consumer caches the ActIntentKey so it can be submitted in a subsequent modification request.

AcctExcTrnInqRq_MType

AcctExcTrnInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • IncXtendElem_AType
  • MsgRqHdr_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.

ExcItemId
The identifier assigned to a specific account exception item.
LnUnitId
The identification assigned to a unit of a loan.

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

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.

AcctExcTrnInqRs_MType

AcctExcTrnInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • ExcRsnRecArray_AType
  • ExcTrnRec_CType
  • InAcctId references AccountId_CType
  • MsgRsHdr_CType
  • TrnDescArray references Rmk_AType
  • x_ACHHistSrchRec_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.

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.
BrCode
The branch code.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
ChngTime
Indicates that time changes were made.
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.
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
ExcRetRsnDesc
The description of the code for an account exception item that conveys the reason the item was returned.
ExcRetSrcCode
The code that describes the recipient source of the return item.
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.
GLCostCtr
The GL cost center provided for bank use in reporting the account to a specific GL cost center.
GLProdCode
The GL product code provided for bank use in reporting the account to a specific GL product code.
LnUnitId
The identification assigned to a unit of a loan.
PostDt
The date a transaction has posted or is scheduled to be posted to an account.
RefDescCode
A code that references a longer description. Used mostly in GL applications where a standard description is used so often that a code replacement is preferable.
SeqNum
The integer assigned to a specific transaction.
TrnAuthBalType

This transaction was authorized based on good funds?

  • true
  • false
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.
UpdTrnCodeDesc
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.

ExcTrnRec_CType

ExcTrnRec_CType is a complex CType element.

Contains:

  • UpdTrnDescArray references Rmk_AType

Simple Elements

The following simple elements are contained within this complex.

ACHRetRsnCode
The Nacha® governed standard return reason codes to describe the reason for returning an ACH entry.
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.
ExcDispCode
The code for an account exception item that conveys the disposition of the item.
ExcRetRsnCode
The code for an account exception item that conveys the reason the item was returned.
ExcRetSrcCode
The code that describes the recipient source of the return item.
UpdAcctId
The number or character that identifies an account record.
UpdAcctType
The number or character that categorizes the AcctId.
UpdBrCode
The branch code.
UpdChkNum
The numbers or characters assigned to monetary drafts, oftentimes referred to as the serial number.
UpdGLCostCtr
The GL cost center provided for bank use in reporting the account to a specific GL cost center.
UpdGLProdCode
The GL product code provided for bank use in reporting the account to a specific GL product code.
UpdLnUnitId
The identification assigned to a unit of a loan.
UpdRefDescCode
A code that references a longer description. Used mostly in GL applications where a standard description is used so often that a code replacement is preferable.
UpdTrnCodeCode
The code that identifies the behavior of a monetary transaction.

UpdTrnDescArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

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

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_CType
  • MsgRecInfoArray_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_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.

TrnDescArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

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

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.

ACHAddeType

Does ACH addenda exist for this entity/resource? Canonical values are:

  • true
  • false
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.
ACHCompName
The ACH company name, as governed by Nacha® rules.
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.

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 Thu Aug 22 2024