Enterprise Solutions

ACH Account Fraud Status Inquiry

Enterprise SOAP API > API by Reference > Core Services > ACH Account Fraud Status Inquiry
ACH Activity Fraud Status Inquiry

ACH Activity Fraud Status Inquiry

ACH Activity Fraud Status Inquiry is a jXchange service for ACH fraud.

Message Flow

In jXchange, the ACH Activity Fraud Status Inquiry service uses a typical exchange of MType messages to allow consumers to inquire on ACH fraud activity.

Primary Request

The consumer forwards the ACHActFraudStatInqRq_MType message to the service provider.

The message contains the following simple elements:

  • FraudRefId
  • ACHBatchNum

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the ACHActFraudStatInqRs_MType message to the consumer.

The message contains the following simple elements:

  • ACHBatchNum
  • ACHFileCrtDt
  • ACJFileCrtTime
  • CmpltTimeDt
  • FraudBatchStat
  • FraudRefId
  • RecCnt
  • SusRecCnt

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

The message contains the following array:

  • ACHFraudRsArray_AType

ACH Activity Fraud Status Inquiry Behavior

ACH Activity Fraud Status Inquiry is a jXchange service for ACH fraud.

The ACH Activity Fraud Status Inquiry service behavior is as follows.

The ACH Activity Fraud Status Inquiry request (ACHActFraudStatInqRq_MType) requires a Fraud Reference ID (FraudRefId) and includes an optional ACHBatchNum. If the ACHBatchNum is not included, then suspects for all batches are returned. The ACH Activity Fraud Status Inquiry response (ACHActFraudStatInqRs_MType) echoes back the FraudRefId and ACHBatchNum. It also returns the Fraud Batch Status with canonical values of Err, Cmplt, and Proc, Record Count (RecCnt), Suspect Record Count (SusRecCnt), and the Completed Time/Date (CmpltTimeDt). This time/date is when the suspect file review completed.

The response also includes details of the ACH items:

  • ACH File Create Date (ACHFileCrtDt) - Nacha® record 1 positions 24-29
  • ACH File Create Time (ACHFileCrtTime) - Nacha® record 1 positions 30-33

Elements within the Fraud Response Array (ACHFraudRsArray_AType):

  • ACH Batch Number (ACHBatchNum) - Nacha® record 5 positions 88-94
  • ACH Company Name (ACHCompName) - Nacha® record 5 positions 5-20
  • ACH Company Id (ACHCompId) - Nacha® record 5 positions 41-50
  • ACH Effective Date (ACHEffDt) - Nacha® record 5 positions 70-75
  • ACH Standard Entry Class (ACHStdEntryClass) - Nacha® record 5 positions 51-53
  • ACH Trace ID (ACHTraceId) - Nacha® record 6 positions 80-94
  • ACH Individual Name (ACHIndvName) - Nacha® record 6 positions 55-76
  • Amount (Amt) - Nacha® record 6 positions 30-39
  • Fraud Suspect Remark Array (FraudSusRmkArray_AType)

ACHActFraudStatInqRq_MType

ACHActFraudStatInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ACHBatchNum
The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
FraudRefId
A unique identification provided by the fraud risk application when a request for review is submitted.

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.

ACHActFraudStatInqRs_MType

ACHActFraudStatInqRs is a message MType element.

Contains:

  • ACHFraudRsArray_AType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ACHBatchNum
The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
ACHFileCrtDt
The date an ACH file was created.
ACHFileCrtTime
The time an ACH file was created.
CmpltTimeDt
The date and time stamp when an item was completed.
FraudRefId
A unique identification provided by the fraud risk application when a request for review is submitted.
RecCnt
The total count of records.
SusRecCnt
The total number of suspect records.

ACHFraudRsArray_AType

ACHFraudRsArray_AType is an array AType element. This array contains fraud result records.

Contains:

  • ACHFraudRsRec_CType

ACHFraudRsRec_CType

ACHFraudRsRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • FraudSusRmkArray references Rmk_AType
Simple Elements

The following simple elements are contained within this complex.

ACHBatchNum
The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
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.
ACHIndvName
The name entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
ACHStdEntryClass
The ACH standard entry class.
ACHTraceId
The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.
Amt
The amount or quantity.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

FraudSusRmkArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

FraudSusRmkArray references Rmk_AType.

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.

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 Mon Jan 24 2022