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

ACH Return NOC (Notification of Change) Search

Enterprise SOAP API > API by Reference > Core Services > ACH Return NOC (Notification of Change) Search

ACH Return NOC Search

ACH Return NOC Search is a jXchange service designed to allow consumers to retrieve any ACH returns or notification of changes (NOC).

Message Flow

In jXchange, the ACH Return NOC Search service uses a typical exchange of MType messages to allow consumers to retrieve any ACH returns or notification of changes (NOC).

Primary Request

The consumer forwards the ACHRetNOCSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • ACHCompID
  • ACHCompName
  • ACHRetNOCType
  • ACHRetRecvEndDt
  • ACHRetRecvStartDt

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

The message contains the following array:

  • ACHCompIdArray_AType

Primary Response

The service provider returns the ACHRetNOCSrchRs_MType message to the consumer.

The message contains the following simple elements:

  • ACHCompID
  • ACHCompName
  • ACHRetNOCType
  • ACHRetRecvEndDt
  • ACHRetRecvStartDt

The message contains the following complex elements:

  • AccountId_CType
  • SrchMsgRsHdr_CType
  • Custom_CType

The message contains the following arrays:

  • ACHCompIdArray_AType
  • ACHRetNOCSrchArray_AType

ACH Return NOC Search Behavior

ACH Return NOC Search is a jXchange service designed to allow consumers to retrieve any ACH returns or notification of changes (NOC).

The ACH Return NOC Search root request (ACHRetNOCSrchRq_MType) optionally includes:

  • Account Identifier (AccountId_CType)
  • ACH Company Identifier (ACHCompId)
  • ACH Company Name (ACHCompName)
  • ACH Return Received End Date (ACHRetRecvEndDt)
  • ACH Return Received Start Date (ACHRetRecvStartDt)

The root request represents filters that could be used to retrieve returns, and all the filters represent an [and] relationship. The recommended ACH Company Name (ACHCompName) search type attribute supports (Wildcard Search Guidelines) specifically Exact, StartsWith, Contains, and ContainsAll.

The absence of any request elements should convey to the service provider to include all returns and NOCs.

The ACH Return Receive Start Date (ACHRetRecvStartDt) and ACH Return Receive End Date (ACHRetRecvEndDate) are compared to element ACH Return Receive Date (ACHRetRecvDt).

A consumer request with an ACH Return Receive Start Date (ACHRetRecvStartDt) but without an ACH Return Receive End Date (ACHRetRecvEndDate) returns all the qualified ACH Return records with a date equal to and greater than the ACH Return Receive Date (ACHRetRecvDt).

A consumer request with an ACH Return Receive End Date (ACHRetRecvEndDate) but without an ACH Return Receive Start Date (ACHRetRecvStartDt) returns all the qualified ACH Return records with a date equal to and less than the ACH Return Receive Date (ACHRetRecvDt).

A consumer request with an ACH Return Receive Start Date (ACHRetRecvStartDt) and an ACH Return Receive End Date (ACHRetRecvEndDate) returns all the qualified ACH Return records with a date equal to and greater than the ACH Return Receive Date (ACHRetRecvDt) and a date equal to and less than the ACH Return Receive Date (ACHRetRecvDt).

The ACH Return NOC Search root response (ACHRetNOCSrchRs_MType) echoes back:

  • Account Identifier (AccountId_CType)
  • ACH Company Identifier (ACHCompId)
  • ACH Company Name (ACHCompName)
  • ACH Return Received End Date (ACHRetRecvEndDt)
  • ACH Return Received Start Date (ACHRetRecvStartDt)

The ACH Return NOC Search root response (ACHRetNOCSrchRs_MType) contains the ACH Return NOC Search Array (ACHRetNOCSrchArray_AType) which contains the ACH Return NOC Search Record complex (ACHRetNOCSrchRec_CType).

The ACH Return NOC Search Record complex (ACHRetNOCSrchRec_CType) contains:

  • Account Identifier (AcctId)
  • Account Type (AcctType)
  • ACH Amount (ACHAmt)
  • ACH Company Identifier (ACHCompId)
  • ACH Company Name (ACHCompName)
  • ACH Record Identifier (ACHRecId)
  • ACH Return Reason Code (ACHRetRsnCode)
  • ACH Return Reason Description (ACHRetRsnDesc)
  • ACH Return Receive Date (ACHRetRecvDt)
  • ACH Transaction Code (ACHTrnCode)
  • Effective Date (EffDt)
  • Original ACH Trace Identifier (OrigACHTraceId)

The standard search message header tenets are applicable.

The standard search message tenets are applicable.

ACHRetNOCSrchRq_MType

ACHRetNOCSrchRq_MType is a message MType element. The absence of any request elements conveys to the provider to return all returns/NOC.

Contains:

  • AccountId_CType
  • ACHCompIdArray_AType - This array is limited to 10 company identifiers. Only use the array in addition to the ACHCompId at the root request.
  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this complex.

ACHCompId
The ACH company ID.
ACHCompName
The ACH company name, as governed by Nacha® rules.
ACHRetNOCType
Is the ACH item a return or NOC? Canonical values are:
  • Ret
  • NOC
ACHRetRecvEndDt
The date that designates the ending point for date selections.
ACHRetRecvStartDt
The date that designates the starting point for date selections.
InitialACHTraceId
The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.

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

ACHCompIdArray_AType

ACHCompIdArray_AType is an array AType element. This is an array of ACH company identifiers.

Contains:

  • ACHCompIdRec_CType

ACHCompIdRec_CType

ACHCompIdRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple element is contained within this complex.

ACHCompId
The ACH company ID.
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.

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.

ACHRetNOCSrchRs_MType

ACHRetNOCSrchRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • ACHCompIdArray_AType
  • ACHRetNOCSrchARray_AType
  • Custom_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this complex.

ACHCompId
The ACH company ID.
ACHCompName
The ACH company name, as governed by Nacha® rules.
ACHRetNOCType
Is the ACH item a return or NOC? Canonical values are:
  • Ret
  • NOC
ACHRetRecvEndDt
The date that designates the ending point for date selections.
ACHRetRecvStartDt
The date that designates the starting point for date selections.
InitialACHTraceId
The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.

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

ACHCompIdArray_AType

ACHCompIdArray_AType is an array AType element. This is an array of ACH company identifiers.

Contains:

  • ACHCompIdRec_CType

ACHCompIdRec_CType

ACHCompIdRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple element is contained within this complex.

ACHCompId
The ACH company ID.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ACHRetNOCSrchArray_AType

ACHRetNOCSrchArray_AType is an array AType element. This is an array of responses for ACH returns and NOC.

Contains

  • ACHRetNOCSrchRec_CType

ACHRetNOCSrchRec_CType

ACHRetNOCSrchRec_CType is a complex CType element.

Contains:

  • Custom_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.
ACHAmt
The amount or quantity.
ACHCompId
The ACH company ID.
ACHCompName
The ACH company name, as governed by Nacha® rules.
ACHEffDt
The date assigned to transactions when it is different from the posting date.
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.
ACHRecId
The identifier given to an ACH record.
ACHRetNOCType
Is the ACH item a return or NOC? Canonical values are:
  • Ret
  • NOC
ACHRetRecvDt
The date an ACH Ret/NOC was received.
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.
ACHRtId

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.

ACHTrnCode
The transaction code to be used for the ACH item, as governed by Nacha® rules.
InitialACHTraceId
The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.
OrigACHTraceID
The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.
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
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