ACH Return NOC (Notification of Change) Inquiry
ACH Return NOC Inquiry
ACH Return NOC Inquiry 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 Inquiry 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 ACHRetNOCInqRq_MType message to the
service provider.
The message contains the following simple element:
- ACHRecID
The message contains the following complex elements:
Custom_CTypeMsgRqHdr_CType
Primary Response
The service provider returns the ACHRetNOCInqRs_MType message
to the consumer.
The message contains the following simple element:
- ACHRecID
The message contains the following complex elements:
ACHRetNOCInqRec_CTypeCustom_CTypeMsgRsHdr_CType
ACH Return NOC Inquiry Behavior
ACH Return NOC Inquiry is a jXchange service designed to allow consumers to retrieve any ACH returns or notification of changes (NOC).
The ACH Return NOC Inquiry root request (ACHRetNOCInqRq_MType) requires a
valid ACH Record Identifier (ACHRecId).
The ACH Return NOC Inquiry root response (ACHRetNOCInqRs_MType)
echos ACH Record Identifier (ACHRecId).
The ACH Return NOC Inquiry root response (ACHRetNOCInqRs_MType) contains ACH
Batch Header (ACHBatchHdr), ACH Detail Information
(ACHDetInfo), and ACH Addenda Array
(ACHAddendaArray_AType).
The ACH Batch Header (ACHBatchHdr) contents are dictated and governed by Nacha® rules for batch information (ACH Record Type Code '5').
The ACH Detail Information (ACHDetInfo) contents are dictated and governed by Nacha® rules for batch information (ACH Record Type Code '6').
The ACH Addenda Array (ACHAddendaArray_AType) contents is dictated and
governed by Nacha® rules for batch information (ACH Record Type Code
'7').
The standard inquiry message tenets are applicable.
ACHRetNOCInqRq_MType
ACHRetNOCInqRq_MType is a message MType element.
Contains:
Custom_CTypeMsgRqHdr_CType
Simple Elements
The following simple element is contained within this message.
- ACHRecId
- The identifier given to an ACH record.
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_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
ACHRetNOCInqRs_MType
ACHRetNOCInqRs_MType is a message MType element.
Contains:
ACHRetNOCINqRec_CTypeCustom_CTypeMsgRsHdr_CType
Simple Elements
The following simple element is contained within this message.
- ACHRecId
- The identifier given to an ACH record.
ACHRetNOCInqRec_CType
ACHRetNOCInqRec_CType is a complex CType element.
Contains:
ACHAddendaArray_ATypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- ACHBatchHdr
- The ACH Batch Header indicates the effective entry date, the company, and the entry description for the credits and debits in the batch. The contents are governed by Nacha® rules.
- ACHDetInfo
- The ACH detail information contains the information necessary to post a deposit to/withdrawal from an account, such as the recipient's name, account number, and the dollar amount of the payment. The contents are governed by Nacha® rules.
- InitialACHTraceId
- The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.
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.
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.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.