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 Search

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

Wire Template Search

Wire Template Search is a jXchange service designed to search wire templates.

Message Flow

In jXchange, the Wire Template Search service uses a typical exchange of MType messages to allow a consumer to search wire templates.

Primary Request

The consumer forwards the WireTmpltSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • CustId
  • IntnetFinInstId
  • WireAcctId
  • WireAcctType
  • WireBenfName
  • WireRecvFinInstName
  • WireSched
  • WireTmpltDesc

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRqHdr_CType

Primary Response

The service provider returns the WireTmpltSrchRs_MType message to the consumer.

The message contains the following simple elements:

  • CustId
  • IntnetFinInstId
  • WireAcctId
  • WireAcctType
  • WireBenfName
  • WireRecvFinInstName
  • WireSched
  • WireTmpltDesc

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRsHdr_CType

The message contains the following array:

  • WireTmpltSrchRecArray_AType

Wire Template Search Behavior

The Wire Template Search root request message (WireTmpltSrchRq_MType) is a documented choice statement whereby all elements are optional, but the request must include one of the following elements: Wire Account Identification element (WireAcctId), Customer Identification element (CustId), Wire Template Description element (WireTmpltDesc), Wire Beneficiary Name element (WireBenfName), Wire Receiving Financial Institution (WireRecvFinInstName), and Internet Financial Institution Identification (IntnetFinInstId).

The Wire Account Type element (WireAcctType) is a filter at the request.

The following elements are decorated with the Search Type (SrchType) attribute: Wire Template Description element (WireTmpltDesc), Wire Beneficiary Name element (WireBenfName), and Wire Receiving Financial Institution Name (WireRecvFinInstName). The Search type canonical values ~Exact~, ~StartsWith~, and ~Contains~ should be supported on all three elements.

The standard wildcard search tenets are applicable.

The Wire Template Search root response (WireTmpltSrchRs_MType) echoes the filter values submitted in the request.

The Wire Template Search Record Array (WireTmpltSrchRecArray) returns:

  • Customer Identification (CustId)
  • Internet Financial Institution Identification (IntnetFinInstId)
  • Wire Account Identification (WireAcctId)
  • Wire Account Type (WireAcctType)
  • Wire Amount (WireAmt)
  • Wire Beneficiary Identification (WireBenfId)
  • Wire Beneficiary Name (WireBenfName)
  • Wire Receiving Financial Institution Name (WireRecvFinInstName)
  • Wire Schedule (WireSched)
  • Wire Schedule Frequency (WireSchedFreq)
  • Wire Schedule Frequency Units (WireSchedFreqUnits)
  • Wire Schedule Next Date (WireSchedNextDt)
  • Wire Schedule Status (WireSchedStat)
  • Wire Template Description (WireTmpltDesc)
  • Wire Template Identification (WireTmpltId)

The standard search message header tenets are applicable. The standard search message tenets are applicable.

WireTmpltSrchRq_MType

WireTmpltSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
IntnetFinInstId
The identification assigned to a consumer for the financial institution internet product.
WireAcctId
The account identification related to wires.
WireAcctType
The number or character that categorizes the AcctId.
WireBenfName
The named beneficiary for a wire transaction.
WireRecvFinInstName
The name of the wire receiving financial institution.
WireSched
A filter used to determine the behavior when searching for wire templates that have a wire schedule. Canonical values are:
  • false
  • true
WireTmpltDesc
The readable description assigned to a wire template.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message 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.
Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MaxRec
The maximum number of records when multiple records are returned.

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.

WireTmpltSrchRs_MType

WireTmpltSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRsHdr_CType
  • WireTmpltSrchRecArray_AType

Simple Elements

The following simple elements are contained within this message.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
IntnetFinInstId
The identification assigned to a consumer for the financial institution internet product.
WireAcctId
The account identification related to wires.
WireAcctType
The number or character that categorizes the AcctId.
WireBenfName
The named beneficiary for a wire transaction.
WireRecvFinInstName
The name of the wire receiving financial institution.
WireSched
A filter used to determine the behavior when searching for wire templates that have a wire schedule. Canonical values are:
  • false
  • true
WireTmpltDesc
The readable description assigned to a wire template.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MoreRec
Indicates if there are more records that could be returned. Canonical values are:
  • false
  • true
SentRec
The number of records sent in the response.
TotRec
Indicates the total records the request selected, which could be larger than MaxRec.

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.

WireTmpltSrchRecArray_AType

WireTmpltSrchRecArray_AType is an array AType element. This is an array of responses for wire template search.

Contains:

  • WireTmpltSrchRec_CType

WireTmpltSrchRec_CType

WireTmpltSrchRec_CType is a complex CType element.

Contains:

  • SvcPrvdInfo references WireTmpltSrchRec_EType
Simple Elements

The following simple elements are contained within this complex.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EntityTmpltCorrelId
The correlation identification as related to business functions and activities.
IntnetFinInstId
The identification assigned to a consumer for the financial institution internet product.
WireAcctId
The account identification related to wires.
WireAcctType
The number or character that categorizes the AcctId.
WireAmt
The transactional amount of the wire transfer.
WireBenfId
The identifier associated with the Wire Beneficiary ID element.
WireBenfName
The named beneficiary for a wire transaction.
WireRecvFinInstName
The name of the wire receiving financial institution.
WireSched
A filter used to determine the behavior when searching for wire templates that have a wire schedule. Canonical values are:
  • false
  • true
WireSchedFreq
The frequency of the transfer.
WireSchedFreqUnits
The units of frequency for the transfer request. Canonical values are:
  • BiWeekSkipFirst
  • BiWeekSkipLast
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • WeekSkipFirst
  • WeekSkipLast
  • Years
WireSchedNextDt
The next scheduled transfer date.
WireSchedStat
Identifies the status of the future transfer schedule. Canonical values are:
  • Active
  • Expired
  • Suspended
WireTmpltDesc
The readable description assigned to a wire template.
WireTmpltId
The identification key assigned to a wire template.
SvcPrvdInfo

WireTmpltSrchRec_EType is an extended EType element.

SvcPrvdInfo references WireTmpltSrchRec_EType.

Contains:

  • JHAConsumer references WireTmpltSrchRec_JIS_CType
JHAConsumer

WireTmpltSrchRec_JIS_CType is a complex CType element.

JHAConsumer references WireTmpltSrchRec_JIS_CType.

Simple Elements

The following simple elements are contained within this complex.

WireTmpltSeq
A sequence number assigned to the template.
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