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

Wire Template Inquiry

Enterprise SOAP API > API by Reference > Core Services > Wire Template Inquiry

Wire Template Inquiry

Wire Template Inquiry is a jXchange service designed to inquire on a specific wire template.

Message Flow

In jXchange, the Wire Template Inquiry service uses a typical exchange of MType messages to allow a consumer to inquire on a specific wire template.

Primary Request

The third-party consumer forwards the WireTmpltInqRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntent
  • WireTmpltId

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the WireTmpltInqRs_MType message to the third-party consumer.

The message contains the following simple elements:

  • ActIntent
  • ActIntentKey
  • WireTmpltId

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • WireTmpltInqRec_CType

The message contains the following extended element:

  • SvcPrvdInfo references WireTmpltInqRs_EType

Wire Template Inquiry Behavior

The Wire Template Inquiry root request message (WireTmpltInqRq_MType) requires the submission of the Wire Template Identification (WireTmpltId) simple element. The Wire Template Identification can be obtained from the Wire Template Search operation (WireTmpltSrch).

The Activity Intention (ActIntent) simple element's default canonical value is ~ReadOnly~. The canonical values ~Upd~ or ~Dlt~ require the service provider to return the Activity Intention Key (ActIntentKey) simple element, which is used for subsequent modification services in conjunction with the adopted concurrency model.

The Wire Template Inquiry root response message (WireTmpltInqRs_MType) returns the Wire Transaction Information Record complex (WireTrnInfoRec_CType) and the descriptions that accompany the ~Code~ elements are returned in the Wire Template Inquiry Record complex (WireTmpltInqRec_CType).

The Wire Transaction Information Record complex (WireTrnInfoRec_CType) was updated with the Wire Other Transfer Information Record complex (WireOthXferInfoRec_CType) and the Wire Schedule Record Array (WireSchedRecArray_AType).

The Wire Other Transfer Information Record complex (WireOthXferInfoRec_CType) returns the Wire Detail Of Charge (WireDetOfChg), Wire Currency Code (WireCurrencyCode), Wire Instructed Amount (WireInstrAmt), and Wire Exchange Rate (WireExchRate) simple elements and the Wire Sender Charge Array (WireSndrChgArray_AType).

The Wire Sender Charge Array (WireSndrChgArray_AType) returns the Wire Sender Charge Record complex (WireSndChgRec_CType).

The Wire Sender Charge Record complex (WireSndChgRec_CType) returns the Wire Sender Charge Order (WireSndrChgOrder) and Wire Sender Charge (WireSndrChg) simple elements.

The Wire Schedule Record Array (WireSchedRecArray_AType) returns the Wire Schedule Record complex (WireSchedRec_CType).

The Wire Schedule Record complex (WireSchedRec_CType) returns the Amount (Amt), Semi Day 1 (SemiDay1), Semi Day 2 (SemiDay2), Wire Schedule First Date (WireSchedFirstDt), Wire Schedule Next Date (WireSchedNextDt), Wire Schedule Expire Date (WireSchedExpDt), Wire Schedule Day Of Month (WireSchedDayOfMonth), Wire Schedule Frequency (WireSchedFreq), Wire Schedule Frequency Units (WireSchedFreqUnits), Wire Schedule Day Of Week (WireSchedDayOfWeek), Wire Schedule Day Of Week Occurrence (WireSchedDayOfWeekOccur), Wire Schedule Status (WireSchedStatus), Wire Initiate Date (WireInitDt), Wire Initiate Time (WireInitTime), and Internet Financial Institution Identification (IntnetFinInstId) simple elements.

The standard Inquiry message tenets are applicable.

Adhere to the tenets for Fault and Warnings. Adhere to the tenets related to Backwards Compatibility.

WireTmpltInqRq_MType

WireTmpltInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

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.

WireTmpltId
The identification key assigned to a wire template.

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.

WireTmpltInqRs_MType

WireTmpltInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • SvcPrvdInfo references WireTmpltInqRs_EType
  • WireTmpltInqRec_CType

Simple Elements

The following simple elements are contained within this message.

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.
WireTmpltId
The identification key assigned to a wire template.

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.

SvcPrvdInfo

WireTmpltInqRs_EType is an extended EType element.

SvcPrvdInfo references WireTmpltInqRs_EType.

Contains:

  • JHAConsumer references WireTmpltInqRs_JIS_CType

JHAConsumer

WireTmpltInqRs_JIS_CType is a complex CType element.

JHAConsumer references WireTmpltInqRs_JIS_CType.

Simple Elements

The following simple elements are contained within this complex.

WireTmpltSeq
A sequence number assigned to the template.

WireTmpltInqRec_CType

WireTmpltInqRec_CType is a complex CType element.

Contains:

  • WireTrnInfoRec_CType

Simple Elements

The following simple elements are contained within this complex.

BrDesc
A description of the branch name. It includes the Rstr attribute.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
GLProdDesc
The GL product code provided for bank use in reporting the account to a specific GL product code.
OffDesc
The officer short name.
WireAcctId
The account identification related to wires.
WireAcctType
The number or character that categorizes the AcctId.
WireAnlysDesc
The description of the code that identifies the behavior for Account Analysis activity for the transaction.
WireStatDesc
The description that identifies the status of the wire transaction.
WireXferTypeDesc
The description of the code that designates the type of wire transfer category.
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