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

Warehoused ACH History Inquiry

Enterprise SOAP API > API by Reference > Core Services > Warehoused ACH History Inquiry

ACH Pending Search

ACH Pending Search is a jXchange service designed to allow a consumer to submit a check number range when searching pending ACH items.

Message Flow

In jXchange, the ACH Pending Search service uses a typical exchange of MType messages to allow a consumer to submit a check number range when searching pending ACH items.

Primary Request

The consumer forwards the ACHPndSrchRq_MType message to the service provider. The message contains the following simple elements:

  • ACHExcInc
  • ACHTrnType
  • ChkNumEnd
  • ChkNumStart
  • ChkNum
  • EffEndDt
  • EffStartDt
  • HighAmt
  • LowAmt

Primary Response

The service provider returns the ACHPndSrchRs_MType message to the consumer. The message contains the following simple elements:

  • ACHExcInc
  • ACHTrnType
  • ChkNumEnd
  • ChkNumStart
  • ChkNum
  • EffEndDt
  • EffStartDt
  • HighAmt
  • LowAmt

ACH Pending Search Behavior

A service provider does not return the same ACH warehoused transaction item twice in the two services AcctMemoPostSrch and ACHPndSrch. This could convey to the consumer two separate transactions, thereby conveying incorrect information to the end consumer.

The request provides the consumer a means to filter for specific ACH pending items.

A consumer request with an EffStartDt and without an EffEndDT returns all the qualified ACH Pending items with a date equal to and less than the effective end date. All the other filters must be considered for the response.

A consumer request with an EffEndDT and without an EffStartDt returns all the qualified ACH Pending items with a date equal to and less than the effective end date. All the other filters must be considered for the response.

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

A consumer request with a ChkNumStart and without a ChkNumEnd returns all the qualified ACH Pending items with a check number equal to and greater than the starting check number.

A consumer request with a ChkNumEnd and without a ChkNumStart returns all the qualified ACH Pending items with a check number equal to and less than the ending check number.

The behavior for the element filter ranges EffStartDt, EffEndDT, LowAmt, HighAmt differs from the current behavior for other search services. All agree that this behavior is a more efficient behavior going forward.

The filter for ACH transaction type provides a means for the service provider to filter for specific debit or credit transactions. The absence of this element conveys to the service provider to return all ACH transaction types.

A filter exists to exclude or include ACH exception posting items. The default behavior for an absence element is to not include the exception items.

ACHPndSrchRq_MType

ACHPndSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId_CType references AccountId_CType
  • 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 simple elements can be sent.

ACHExcInc
A filter used to allow the consumer to exclude or include ACH transaction items that are considered exceptions. These are ACH transactions that are pending, and due to an exception, might not be applied to the account. Canonical values are:
  • false
  • true
ACHTrnType
The grouping of monetary transactions by a specific 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.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
EffEndDt
The date that designates the ending point for date selections.
EffStartDt
The date that designates the starting 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.

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.

This element 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
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.

ACHPndSrchRs_MType

ACHPndSrchRs_MType is a message MType element.

Contains:

  • ACHPndSrchRecArray_AType
  • Custom_CType
  • InAcctId references AccountId_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ACHExcInc
A filter used to allow the consumer to exclude or include ACH transaction items that are considered exceptions. These are ACH transactions that are pending, and due to an exception, might not be applied to the account. Canonical values are:
  • false
  • true
ACHTrnType
The grouping of monetary transactions by a specific code.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
ChkNumStart
The numbers or characters that designate a starting point for check number selections.
ChkNumEnd
The numbers or characters that designate an ending point for check number selections.
EffEndDt
The date that designates the ending point for date selections.
EffStartDt
The date that designates the starting 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.

ACHPndSrchRecArray_AType

ACHPndSrchRecArray_AType is an array AType element. This is an array of responses for an ACH pending items search.

Contains:

  • ACHPndSrchRec_CType

ACHPndSrchRec_CType

ACHPndSrchRec_CType is a complex CType element.

Contains:

  • ACHAcctId
  • ACHAddendaArray_AType
  • CustomACHPndSrchRec_CType references Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ACHAltCompName
The alternate company name that can be used for EFT description requirements.
ACHCompDiscrData
The ACH company discretionary data, as governed by Nacha® rules.
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.
ACHIndvId
The ID entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
ACHStdEntryClass
The ACH standard entry class.
ACHTrnCodeCode
The code that identifies the behavior of a monetary transaction.
ACHTrnCodeDesc
The description of the code that identifies the behavior of a monetary transaction.
ACHTrnStat
The status that represents the state or condition of a monetary transaction.
ACHTrnType
The grouping of monetary transactions by a specific code.
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.
ACHAcctId

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

It contains the incoming account identification information and any restrictions.

ACHAcctId 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
ACHAddendaArray_AType

ACHAddendaArray_AType is an array AType element. This is an array containing ACH addenda records.

Contains:

  • ACHAddendaInfoRec_CType
ACHAddendaInfoRec_CType

ACHAddendaInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ACHAddenda
An ACH record type carrying the supplemental data needed to completely identify an account holder or provide information concerning a payment to the RDFI and the receiver.
CustomAchPndSrchRec

Custom_CType is a complex CType element.

CustomAchPndSrchRec references Custom_CType.

This element is optional.

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

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 Wed Dec 13 2023