Enterprise Solutions

ACH Filter Search

Enterprise SOAP API > API by Reference > Core Services > ACH Filter Search
ACH Filter Search

ACH Filter Search

ACH Filter Search is a jXchange service designed to allow consumers to obtain a listing of ACH filters as related to an account identifier.

Message Flow

In jXchange, the ACH Filter Search service uses a typical exchange of MType messages to allow consumers to obtain a listing of ACH filters as related to an account identifier.

Primary Request

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

  • ACHCompAlwType
  • ACHCompName
  • ActIntent
  • HighAmt
  • LowAmt

Primary Response

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

  • ACHCompAlwType
  • ACHCompName
  • ActIntent
  • ActIntentKey
  • HighAmt
  • LowAmt

ACH Filter Search Behavior

The ACH Filter Search (ACHFltrSrch) service behavior is as follows.

The ACH Filter Search root request message (ACHFltrSrchRq_MType) requires a valid Account Identification (AccountId_CType). The ACH Filter Search root request message (ACHFltrSrchRq_MType) optionally includes the filters for the ACH Company Name (ACHCompName), Low Amount (LowAmt), High Amount (HighAmt), ACH Company Allowed Type (ACHCompAlwType), and Activity Intention (ActIntent) simple elements.

The ACH Company Name (ACHCompName) search type attribute supports the [Exact], StartsWith, Contains, and ContainsAll canonical values.

The ACH Filter Low Amount (LowAmt) and High Amount (HighAmt) are compared to the simple elements Low Amount (LowAmt) or High Amount (HighAmt).

A consumer request with a Low Amount (LowAmt) but without a High Amount (HighAmt) returns all the qualified ACH Filter records with an amount equal to and greater than the Low Amount (LowAmt) or High Amount (HighAmt).

A consumer request with a High Amount (HighAmt) but without a Low Amount (LowAmt) returns all the qualified ACH Filter records with an amount equal to and less than the High Amount (HighAmt) or Low Amount (LowAmt).

A consumer request with a Low Amount (LowAmt) and a High Amount (HighAmt) returns all the qualified ACH Filter records with an amount equal to and greater than the Low Amount (LowAmt) or High Amount (HighAmt) and an amount equal to and less than the High Amount (HighAmt) or Low Amount (LowAmt).

The ACH Filter Search root response message (ACHFltrSrchRs_MType) echoes back the Account Identifier (AccountId_CType), ACH Company Name (ACHCompName), Low Amount (LowAmt), High Amount (HighAmt), and ACH Company Allowed Type (ACHCompAlwType).

The ACH Filter Search root response message (ACHFltrSrchRs_MType) contains the ACH Filter Search Record (ACHFltrSrchRec_CType), Activity Intention (ActIntent), and Activity Intention Key (ActIntentKey).

The ACH Filter Search Record complex (ACHFltrSrchRec_CType) contains the ACH Filter Information Record (ACHFltrInfoRec_CType).

The ACH Filter Information Record complex (ACHFltrInfoRec_CType) contains the ACH Allowable Transaction Type (ACHAlwTrnType), Allowable Positive Pay Type (AlwPosPayType), and ACH Filter Array (ACHFltrArray_AType).

The ACH Filter Array (ACHFltrArray_AType) contains the ACH Allowable Transaction Type (ACHAlwTrnType), ACH Company Identifier (ACHCompId), ACH Company Name (ACHCompName), ACH Standard Entry Class (ACHStdEntryClass), Low Amount (LowAmt), High Amount (HighAmt), Expiration Date (ExpDt), ACH Filter Status Type (ACHFltrStatType), and ACH Company Allowable Type (ACHCompAlwType).

The standard Search message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

Adhere to the tenets for wild card searches.

ACHFltrSrchRq_MType

ACHFltrSrchRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ACHCompAlwType
Answers the question: is the ACH company allowed? Canonical values are:
  • false
  • true
ACHCompName
The ACH company name, as governed by NACHA rules.
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.

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.

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.

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.

ACHFltrSrchRs_MType

ACHFltrSrchRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • ACHFltrSrchRec_CType
  • Custom_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ACHCompAlwType
Answers the question: is the ACH company allowed? Canonical values are:
  • false
  • true
ACHCompName
The ACH company name, as governed by NACHA rules.
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.
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.

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

ACHFltrSrchRec_CType

ACHFltrSrchRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • ACHFltrInfoRec_CType
ACHFltrInfoRec_CType

ACHFltrInfoRec_CType is a complex CType element.

Contains:

  • ACHFltrArray_AType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ACHAlwTrnType
The allowable ACH transaction types. Canonical values are:
  • All
  • Cr
  • Dr
AlwPosPayType
Answers the question: Is the account/customer permitted for Positive Pay? Canonical values are:
  • false
  • true
ACHFltrArray_AType

ACHFltrArray_AType is an array AType element. This is an array of ACH filters.

Contains:

  • ACHFltrRec_CType
ACHFltrRec_CType

ACHFltrRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ACHAlwTrnType
The allowable ACH transaction types. Canonical values are:
  • All
  • Cr
  • Dr
ACHCompAlwType
Answers the question: is the ACH company allowed? Canonical values are:
  • false
  • true
ACHCompFltrId
The ACH Filter company identifier.
ACHCompId
The ACH company ID.
ACHCompName
The ACH company name, as governed by NACHA rules.
ACHFltrStatType
The ACH filter type of status. Canonical values are:
  • Act
  • Inact
ACHStdEntryClass
The ACH standard entry class.
ExpDt
The expiration date.
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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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