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

Teaser Rate Search

Enterprise SOAP API > API by Reference > Core Services > Teaser Rate Search

Teaser Rate Search

Teaser Rate Search is a jXchange service designed to support consumer interaction with promotional/teaser rate parameters.

Message Flow

In jXchange, the Teaser Rate Search service uses a typical exchange of MType messages to support consumer interaction with promotional/teaser rate parameters.

Primary Request

The consumer forwards the TeaserRateSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • AcctType
  • BrCode
  • IncExpType
  • ProdCode
  • RegionCode

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRqHdr_CType

Primary Response

The service provider returns the TeaserRateSrchRs_MType message to the consumer.

The message contains the following simple element:

  • IncExpType

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRsHdr_CType

The message contains the following array:

  • TeaserRateSrchRecArray_AType

Teaser Rate Search Behavior

Teaser Rate Search is a jXchange service designed to support consumer interaction with promotional/teaser rate parameters.

The Teaser Rate Search service behavior is as follows.

The Teaser Rate Search root request message (TeaserRateSrch_MType) contains Include Expired Type (IncExpType). The default value is false. This element allows the provider to return only active promotional rates. If the consumer wants to receive unexpired and expired promotional rates, Include Expired Type (IncExpType) must be set to true.

A documented filter statement is also included in the Teaser Rate Search root request where the elements at the root are optional but at least one of the elements are required. The Account Type (AcctType), Branch Code (BrCode), Region Code (RegionCode), and Product Code (ProdCode) are available at the root request. The service provider reserves the right to limit the response set by requiring an Account Type (AcctType).

The Teaser Rate Search root response (TeaserRateSrchRs_MType) echoes back the Include Expired Type (IncExpType) request element. The Teaser Rate Search Record Array (TeaserRateSrchRecArray_AType) returns all the items related to the Teaser Rate Search request documented filters.

The standard search message header tenets are applicable.

The standard search message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

TeaserRateSrchRq_MType

TeaserRateSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

AcctType
The number or character that categorizes the AcctId.
BrCode
The branch code.
IncExpType
Include expired records when performing a search? Canonical values are:
  • true
  • false
ProdCode

The code that identifies a product type of account within an application. Canonical values are:

  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

RegionCode
The code that identifies a financial institution's region that would encompass a group of branches.

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.

TeaserRateSrchRs_MType

TeaserRateSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRsHdr_CType
  • TeaserRateSrchRecArray_AType

Simple Elements

The following simple element is contained within this message.

IncExpType
Include expired records when performing a search? Canonical values are:
  • true
  • false

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.

TeaserRateSrchRecArray_AType

TeaserRateSrchRecArray_AType is an array AType element. This is an array of responses related to a promotion/teaser rate search.

Contains:

  • TeaserRateSrchRec_CType

TeaserRateSrchRec_CType

TeaserRateSrchRec_CType is a complex CType element.

Contains:

  • TeaserRateTierRecArray_AType
Simple Elements

The following simple elements are contained within this complex.

AcctType
The number or character that categorizes the AcctId.
BrCode
The branch code.
BrDesc
A description of the branch name. It includes the Rstr attribute.
ProdCode

The code that identifies a product type of account within an application. Canonical values are:

  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

ProdDesc
Description of the type of account.
RegionCode
The code that identifies a financial institution's region that would encompass a group of branches.
RegionDesc
The description of the code that identifies a financial institution's region that would encompass a group of branches.
TeaserAnnPctYield
The annual percentage yield (APY).
TeaserRate
A rate that is paid specific to an account for a period of time.
TeaserRateCode
The code that indicates the type of teaser rate.
TeaserRateDesc
The description of the code that indicates the type of teaser rate.
TeaserRateEffDt
The effective start date for a rate that is paid specific to an account for a period of time.
TeaserRateExpDays
The integer length of the term.
TeaserRateExpDt
The expiration date for a rate that is paid specific to an account for a period of time.
TeaserRateTierRecArray_AType

TeaserRateTierRecArray_AType is an array AType element. This is an array of responses for the tier values related to a promotion/teaser rate.

Contains:

  • TeaserRateTierRec_CType
TeaserRateTierRec_CType

TeaserRateTierRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

TierAnnPctYield
The annual percentage yield (APY) for tier rates.
TierRate
A tiered rate.
TierRateBal
The threshold balance used to initiate a tiered rate.
TierRateText
The text used to describe the proceeding elements in the tier record.
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 Fri Oct 25 2024