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

Loan Rate Schedule Search

Enterprise SOAP API > API by Reference > Core Services > Loan Rate Schedule Search

Loan Rate Schedule Search

Loan Rate Schedule Search is a jXchange service that was designed due to clarification of the rule regarding rate changes for Regulation Z open-end, non-Real Estate secured variable rate consumer accounts. This ruling requires that lenders send a notice 45 days before a rate increase for accounts with the following characteristics: Consumer Loan, Open end, Variable Rate, Not Real Estate secured, and Floor rate is present on the loan.

Message Flow

In jXchange, the Loan Rate Schedule Search service uses a typical exchange of MType messages to search for loan rate schedules that meet the criteria entered within the request.

Primary Request

The consumer forwards the LnRateSchedSrchRq_MType message to the Service Provider. The message contains the following simple elements:

  • LnUnitId
  • RateChngEffStartDt
  • RateChngEffEndDt
  • RateRevEndDt
  • RateRevStartDt
  • RateRevStat

Primary Response

The Service Provider returns the LnRateSchedSrchRs_MType message to the consumer. The message contains the following simple elements:

  • LnUnitId
  • RateChngEffStartDt
  • RateChngEffEndDt
  • RateRevEndDt
  • RateRevStartDt
  • RateRevStat

Loan Rate Schedule Search Behavior

The LnRateSchedSrchRq_MType message request requires the InAcctId_CType complex.

The LnRateSchedSrchRq_MType message request includes an optional documented key for the RateRevStat element. The default value is to return all statuses. The LnRateSchedSrchRq_MType message request includes documented filters that may be submitted with the documented key. These filters include date ranges.

A request with a RateRevStartDt and without a RateRevEndDt returns all the qualified Loan Rate Schedule entries with a date equal to and greater than the RateRevStartDt.

A request with a RateRevEndDt and without a RateRevStartDt returns all the qualified Loan Rate Schedule entries with a date equal to and less than the RateRevEndDt.

A consumer request without a RateRevStartDt or a RateRevEndDt returns all the qualified Loan Rate Schedule entries for the keys requested.

The service provider's date value being used for the RateRevDt is used for the rate review date range comparisons.

A request with a RateChngEffStartDt and without a RateChngEffEndDt returns all the qualified Loan Rate Schedule entries with a date equal to and greater than the RateChngEffStartDt.

A request with a RateChngEffEndDt and without a RateChngEffStartDt returns all the qualified Loan Rate Schedule entries with a date equal to and less than the RateChngEffEndDt.

A request without a RateChngEffStartDt or a RateChngEffEndDt returns all the qualified Loan Rate Schedule entries for the keys requested.

The service provider's date value being used for the NewRateEffDt is used for the rate change effective date range comparisons.

The elements in the LnRateSchedSrchRq_MType message request are echoed in the LnRateSchedSrchRs_MType message response, even if the same elements exist in the repeating complex.

LnRateSchedSrchRq_MType

LnRateSchedSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

LnUnitId
The identification assigned to a unit of a loan.
RateChngEffEndDt
The date that designates the ending point for date selections.
RateChngEffStartDt
The date that designates the starting point for date selections.
RateRevEndDt
The date that designates the ending point for date selections.
RateRevStartDt
The date that designates the starting point for date selections.
RateRevStat
The status of an account identification's rate change activity. Canonical values are:
  • Apply
  • Cancel
  • Pend
  • Replace

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

InAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

InAcctId references AccountId_CType.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

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.

LnRateSchedSrchRs_MType

LnRateSchedSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • LnRateSchedSrchArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

LnUnitId
The identification assigned to a unit of a loan.
RateChngEffEndDt
The date that designates the ending point for date selections.
RateChngEffStartDt
The date that designates the starting point for date selections.
RateRevEndDt
The date that designates the ending point for date selections.
RateRevStartDt
The date that designates the starting point for date selections.
RateRevStat
The status of an account identification's rate change activity. Canonical values are:
  • Apply
  • Cancel
  • Pend
  • Replace

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

InAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

InAcctId references AccountId_CType.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

LnRateSchedSrchArray_AType

LnRateSchedSrchArray_AType is an array AType element. This is an array of responses for loan rate schedules.

Contains:

  • LnRateSchedSrchRec_CType

LnRateSchedSrchRec_CType

LnRateSchedSrchRec_CType is a complex CType element.

Contains:

  • SvcPrvdInfo references LnRateSchedSrchRec_EType
Simple Elements

The following simple elements are contained within this complex.

RateRevStat
The status of an account identification's rate change activity. Canonical values are:
  • Apply
  • Cancel
  • Pend
  • Replace
RateRevDt
The date used to determine if a rate should be changed.
NewRate
The current interest rate for a specific account on a specific date.
NewRateEffDt
The effective date a new rate is applied to an account.
PrimeRateIdx
The prime rate index.
LnUnitId
The identification assigned to a unit of a loan.

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.
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