ACH Filter Inquiry
ACH Filter Inquiry
ACH Filter Inquiry is a jXchange service designed to allow a consumer to inquire on ACH filters.
Message Flow
In jXchange, the ACH Filter Inquiry service uses a typical exchange of
MType messages to provide consumers the ability to inquire on ACH
filters.
Primary Request
The consumer forwards the ACHFltrInqRq_MType message to the
service provider. The message contains the following simple elements:
- ACHCompFltrId
- ActIntent
Primary Response
The service provider returns the ACHFltrInqRs_MType message
to the consumer. The message contains the following simple elements:
- ACHCompFltrId
- ActIntent
- ActIntentKey
ACH Filter Inquiry Behavior
The ACH Filter Inquiry service behavior is as folows.
The ACH Filter Inquiry root request message
(ACHFltrInqRq_MType) requires a valid Account Identification
(AccountId_CType). The ACH Company Filter Identifier
(ACHCompFltrId) is optional.
The ACH Company Filter Identifier (ACHCompFltrId) can be cached from the ACH Filter Search response.
The Root request optionally includes the Activity Intention element (ActIntent) with the concurrency model tenet.
The ACH Filter Inquiry Response (ACHFltrInqRs_MType) echoes
back Account Identification complex (AccountId_CType), ACH Company Filter
Identifier (ACHCompFltrId), and Activity Intention
(ActIntent).
The ACH Filter Inquiry Response (ACHFltrInqRs_MType) returns
ACH Filter Information complex (ACHFltrInfo_CType) and Activity Intention Key
(ActIntentKey).
The ACH Filter Information complex (ACHFltrInfo_CType) contains
the ACH Allow Transaction Type (ACHAlwTrnType), Allowable Positive Pay
Type (AlwPosPayType), and ACH Filter Company Information Record complex
(ACHFltrCompInfoRec_CType).
The ACH Filter Company Information Record complex
(ACHFltrCompInfoRec_CType) contains the following elements:
- ACH Allow Transaction Type (ACHAlwTrnType)
- ACH Company Allowable Type (ACHCompAlwType)
- ACH Company Id (ACHCompId)
- ACH Company Name (ACHCompName)
- ACH Filter Remark (ACHFltrRmk)
- ACH Filter Status Type (ACHFltrStatType)
- ACH Institution Routing Identifier (ACHInstRtId)
- ACH Standard Entry Class (ACHStdEntryClass)
- Expiration Date (ExpDt)
- High Amount (HighAmt)
- Low Amount (LowAmt)
Adhere to standard Inquiry message tenets.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
Adhere to the tenets related to the concurrency models.
ACHFltrInqRq_MType
ACHFltrInqRq_MType is a message MType element.
Contains:
AccountId_CTypeCustom_CTypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ACHCompFltrId
- The ACH Filter company identifier.
- 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.
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.
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.
ACHFltrInqRs_MType
ACHFltrInqRs_MType is a message MType element.
Contains:
AccountId_CTypeACHFltrInfo_CTypeCustom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ACHCompFltrId
- The ACH Filter company identifier.
- 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.
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
ACHFltrInfo_CType
ACHFltrInfo_CType is a complex CType element.
Contains:
ACHFltrCompInfoRec_CTypeCustom_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
ACHFltrCompInfoRec_CType
ACHFltrInfo_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
- ACHCompId
- The ACH company ID.
- ACHCompName
- The ACH company name, as governed by NACHA rules.
- ACHFltrRmk
- Application or user remarks free-form text.
- ACHFltrStatType
- The ACH filter type of status. Canonical values are:
- Act
- Inact
- ACHInstRtId
- 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.
- 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.
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_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_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.
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.