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

Entity ACH Batch Inquiry

Enterprise SOAP API > API by Reference > Fraud Services > Entity ACH Batch Inquiry

Entity ACH Batch Inquiry

Entity ACH Batch Inquiry is a jXchange service designed to allow consumers to submit an ACH batch of transactions for screening with agencies' entity values.

Message Flow

In jXchange, the Entity ACH Batch Inquiry service uses a typical exchange of MType messages to allow consumers to submit an ACH batch of transactions for screening with agencies' entity values.

Primary Request

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

  • ACHNACHAFile
  • ACHFileType
  • EntityConfdScore
  • OFIFileName
  • OFIRsDlvryType

Primary Response

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

  • EntityBatchRefId
  • RsStat

Entity ACH Batch Inquiry Behavior

The Entity ACH Batch Inquiry service behavior is as follows.

The Entity ACH Batch Inquiry root request (EntityACHBatchInqRq_MType) requires an ACH File Type (ACHFileType) and either an ACH NACHA File (ACHNACHAFile) or an OFI File Name (OFIFileName). The root request optionally includes the Entity Confidence Score (EntityConfdScore), and an OFI Response Delivery Type (OFIRsDlvryType).

The ACH NACHA File (ACHNACHAFile) is a formatted ACH file that must meet NACHA standards and include all ACH file types (headers, batch headers, detail records, and trailers).

The ACH File Type (ACHFileType) identifies the direction of the ACH file with the canonical values Incoming and Outgoing.

The Entity ACH Batch Inquiry root request (EntityACHBatchInqRq_MType) updated with a document choice statement whereas the ACH NACHA File (ACHNACHAFile) and OFI File Name (OFIFileName) are both optional but at least one must be included in the request.

The Consumer Reference Identifier (ConsmRefId) is prefixed to the batch name for the user experience ([ConsmRefId]_[EntityBatchRefId]). The service consumer can dictate the provisions for the Consumer Reference Identifier (ConsmRefId). The Consumer Reference Identifier (ConsmRefId) is limited to A-Z or 0–9 with no special characters or spaces. It is not case-sensitive.

The consumer must utilize the OFI File delivery method if the ACH NACHA file exceeds 3 MB.

The consumer publishes event 50030 upon delivery of the ACH NACHA file to OFI processor.

Adhere to OFI Architectural guidelines.

The Entity ACH Batch Inquiry root response (EntityACHBatchInqRs_MType) includes the Entity Batch Reference Identifier (EntityBatchRefId). The consumer caches this value for the subsequent Entity Match Batch Status inquiry.

EntityACHBatchInqRq_MType

EntityACHBatchInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • EntityListCodeArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ACHFileType
Identifies the type of ACH file. Canonical values are:
  • Incoming
  • Outgoing
ACHNACHAFile
A formatted ACH file that meets Nacha® standards.
ConsmRefId
A reference assigned to an activity by the consumer of the service.
EntityConfdScore
The value given to an entity based on the confidence of a match related to that entity.
OFIFileName
The name of the file delivered to OFI.
OFIRsDlvryType
Should the response to the batch request return in the OFI application only? Canonical values are:
  • false
  • true

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EntityListCodeArray_AType

EntityListCodeArray_AType is an array AType element. This is an array of entity list codes.

Contains:

  • EntityListCodeRec_CType

EntityListCodeRec_CType

EntityListCodeRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

EntityListAgencyDesc
The description of the code that represents a published list of entity names typically managed by a governmental agency.
EntityListDesc
The description of the code that represents a published list of entity names typically managed by a governmental agency.
EntityListType
The code that represents a published list of entity names typically managed by a governmental agency. This is a hybrid enumeration due to custom lists. Canonical values are:
  • FinCEN
  • OFAC
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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.

EntityACHBatchInqRs_MType

EntityACHBatchInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

EntityBatchRefId
A unique identification provided by the entity matching application when a request for batch is queued.
RsStat

The status of the response. Canonical values are:

  • fail
  • success

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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.
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 Feb 8 2024