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

Interest Rate Search

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

Interest Rate Search

Interest Rate Search is designed to retrieve relevant interest rate information about the financial institution's offerings for the consumer.

Message Flow

Involves the exchange of messages containing XML complex data of type MType between the Third Party Consumer and the Service Provider.

Primary Request

The Third Party consumer transmits (or sends) the message IntRateSrchRq_MType containing elements such as: SrchMsgRqHdr, Custom, and a few optional simple elements designed to filter the request.

Primary Response

The Service Provider returns the message IntRateSrchRs_MType which contains IntRateSrchRecArray. The IntRateSrchRecArray contains an array of responses for an interest rate search.

Interest Rate Search Behavior

Overview

No inputs on the request conveys to the service provider to return all products and their respective rates.

The request allows for a search for a specific product or account type. The product or account type can be filtered by region and/or branch.

A search request submitted with only account type entered returns all of the products related to the account.

A request can be made without a product code but with a branch and/or region. This returns all products with their respective rates for that specific branch and/or region.

The tiers that might exist for a product should be returned in the response.

Interest Rate Search Business Case

In this example, a consumer is requesting interest rate information on a particular time deposit product.

The consumer sends the IntRateSrchRq_MType message to the Service Provider with the following information:

The SrchMsgRqHdr follows the standard header requirements.

Complex ElementSimple ElementEntry Value
AcctTypeT
ProdCode105
BrCode01
RegionCode110

The Service Provider returns the IntRateSrchRs_MType message containing the IntRateSrchRecArray_AType encapsulating the IntRateSrchRec_CType with the following values:

Complex ElementSimple ElementEntry Value
AcctTypeT
ProdCode105
BrCode01
RegionCode110
IntRate3.50
AnnPctYield3.67

Interest Yield Inquiry Business Case

In this example, a consumer submits an interest rate on a time deposit in order to obtain the Annual Percentage Yield.

The consumer sends the IntYieldInqRq_MType message to the Service Provider with the following information:

The MsgRqHdr follows the standard header requirements.

Complex ElementSimple ElementEntry Value
AcctTypeT
IntRate3.50
CurBal250.00
AccrMethCompounded
MndtryIntWthdwlFalse

The Service Provider returns the IntYieldInqRs_MType message with the following information:

The MsgRsHdr follows the standard header requirements.

Complex ElementSimpleElementEntry Value
AcctTypeT
IntRate3.50
CurBal250.00
AccrMethCompounded
MndtryIntWthdwlFalse
AnnPctYield3.67

IntRateSrchRq_MType

IntRateSrchRq_MType is a message MType element.

Contains:

  • SrchMsgRqHdr_CType
  • Custom_CType

Simple Elements

The following simple elements are contained within this message.

This is a documented filter statement. Any or all of the following simple elements can be sent:

AcctType
The number or character that categorizes the AcctId.
BrCode
The branch code.
ProdCode
The code that identifies a product type of account within an application.
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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.

IntRateSrchRs_MType

IntRateSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • IntRateSrchRecArray_AType
  • SrchMsgRsHdr_CType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IntRateSrchRecArray_AType

IntRateSrchRecArray_AType is an array AType element. This is an array of responses for an interest rate search.

Contains:

  • IntRateSrchRec_CType

IntRateSrchRec_CType

IntRateSrchRec_CType is a complex CType element.

Contains:

  • IntRateTierRecArray_AType
Simple Elements
The simple elements contained within this complex are listed below.
AcctType
The number or character that categorizes the AcctId.
AnnPctRate
The annual percentage rate (APR).
AnnPctYield
The annual percentage yield (APY).
BrCode
The branch code.
BrDesc
A description of the branch name. It includes the Rstr attribute.
IntRate
The interest rate.
ProdCode
The code that identifies a product type of account within an application.
ProdDesc
Description of the type of account.
RateIdxDesc
The rate index description.
RateIdxNum
The rate index number to which the loan is tied.
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.
IntRateTierRecArray_AType

IntRateTierRecArray_AType is an array AType element. This is an array of responses for the tier values for an interest rate search.

Contains:

  • IntRateTierRec_CType
IntRateTierRec_CType

IntRateTierRec_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

AnnPctRate
The annual percentage rate (APR).
AnnPctYield
The annual percentage yield (APY).
AnnPctYieldFlr
The annual percentage yield (APY).
TierRate
A tiered rate.
TierRateBal
The threshold balance used to initiate a tiered rate.
TierRateCeilBal
The threshold balance used to initiate a tiered rate.
TierRateIdxDesc
The description of a tiered rate index number.
TierRateIdxNum
A tiered rate index number.
TierRateOrder
The sequential order of rates in tier rate arrangement.
TierRateType
Used to identify the type of interest rate tier. Canonical values are:
  • Fixed
  • Renew
  • Vrbl

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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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 Soap Header Fault 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