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.
Developer Account
Create a developer acccount to access resources that help you integrate with Jack Henry.
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 Hub
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.

Wire Regulatory Report Inquiry

Enterprise SOAP API > API by Reference > Core Services > Wire Regulatory Report Inquiry

Wire Regulatory Reporting Inquiry

Wire Regulatory Reporting Inquiry is a jXchange service that allows consumers to extract an incoming wire's regulatory information.

Message Flow

In jXchange, the Wire Regulatory Reporting Inquiry service uses a typical exchange of MType messages to allow consumers to extract an incoming wire's regulatory information.

Primary Request

The consumer forwards the WireRegRptInqRq_MType message to the service provider.

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

The message contains the following array element:

  • WireRegRptArray_AType

Primary Response

The service provider returns the WireRegRptInqRs_MType message to the consumer.

The message contains the following simple element:

  • FedMsgCode

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • WireDrwdwn_CType
  • WireFinInst_CType

This message contains the following array element:

  • WirePrxyArray_AType

Wire Regulatory Reporting Inquiry Behavior

The Wire Regulatory Inquiry (WireRegRptInq) service behavior is as follows.

The Wire Regulatory Reporting Inquiry root request (WireRegRptInqRq_MType) optionally includes OMAD (OMAD), Wire Reference Identifier (WireRefId), and Wire Correlation Identifier (WireCorrelId).

The OMAD, Wire Reference Identifier, and Wire Correlation ID are part of a documented choice statement where all are optional but at least one is required.

The Wire Regulatory Reporting Inquiry Response (WireRegRptInqRs_MType) returns Wire Regulatory Reporting Array (WireRegRptArray_AType).

The Wire Regulatory Reporting Array encapsulates Wire Regulatory Reporting Information Record complex (WireRegRptInfoRec_CType), which encapsulates Wire Regulatory Identifier (WireRegId), which serves as the key to the array, Wire Regulatory Debit Credit Type (WireRegDrCrType), Entity Name (EntityName), Country Type (CntryType), and Wire Regulatory Details Array (WireRegDetailsArray_AType).

The Wire Regulatory Details Array (WireRegDetailsArray_AType) encapsulates Wire Regulatory Details ID (WireRegDetailsId), which serves as the key to the details array, Wire Regulatory Description (WireRegDesc), Wire Regulatory Report Date (WireRegRptDt), Country Type (CntryType), Amount (Amt), Currency Type (CurrType), and Wire Regulatory Remark Array (WireRegRmkArray_AType).

Adhere to the guidelines established for an inquiry service.

WireRegRptInqRq_MType

WireRegRptInqRq_MType is a message MType element.

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message:

OMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
WireCorrelId
The client assigned correlation identification for wire activities.
WireRefId
The wire reference identification provided to a transaction.

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 submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. 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.

WireRegRptInqRs_MType

WireRegRptInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • WireRegRptArray_AType

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 submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. 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.

WireRegRptArray_AType

WireRegRptArray_AType is an array AType element. This element is an array details of regulatory reporting wire details.

Contains:

  • WireRegDetailsRec_CType
WireRegRptInfoRec_CType

WireRegRptInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • WireRegDetailsArray_AType
Simple Elements

The following simple elements are contained within this complex:

CntryType
The country abbreviation from ISO 3166.
EntityName
The common name. The full-text line name like John Doe.
WireRegDrCrType
Defines the category of the wire regulatory information. Canonical values are:
  • Cr
  • Dr
  • DrCr
WireRegId
The identifier that could be the key for the array of wire regulatory info.
WireRegDetailsArray_AType

WireRegDetailsArray_AType is an array AType element. This element is an array of regulatory reporting wire details.

Contains:

  • WireRegDetailsRec_CType
WireRegDetailsRec_CType

WireRegDetailsRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • WireRegRmkArray references Rmk_AType
Simple Elements

The following simple elements are contained within this complex:

Amt
The amount or quantity.
CntryType
The country abbreviation from ISO 3166.
CurrType
The alphanumeric ISO 4217 currency code.
WireRegCode
The code that represents the nature, purpose, and reason for the transaction to be reported for regulatory requirements.
WireRegDesc
The description of the type of information supplied in the regulatory reporting.
WireRegDetailsId
The identifier that could be the key for the array of wire regulatory detail info.
WireRegRptDt
The date related to the regulatory reporting.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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 Tue Feb 11 2025