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 Platform Product Search

Enterprise SOAP API > API by Reference > Platform Services > Loan Platform Product Search

Loan Platform Product Search

Loan Platform Product Search is a jXchange service designed to allow a consumer product to search for loan and deposit products available in a platform provider product.

Message Flow

In jXchange, the Loan Platform Product Search service uses a typical exchange of MType messages to allow a consumer product to search for loan and deposit products available in a platform provider product.

Primary Request

The consumer forwards the LnPltfmProdSrchRq_MType message to the service provider. The message contains the following simple elements:

  • BrCode
  • CollatCode
  • OpenCeilAmt
  • OpenFlrAmt
  • PlnType
  • ProdTermUnits
  • ProdTermFlr
  • ProdTermCeil
  • PltfmCatCode
  • PltfmCustType
  • PurpCode
  • RateType
  • RegionCode

Primary Response

The service provider returns the LnPltfmProdSrchRs_MType message to the third-party consumer. The message contains the following simple elements:

  • BrCode
  • CollatCode
  • OpenCeilAmt
  • OpenFlrAmt
  • PltfmCatCode
  • PltfmCustType
  • PlnType
  • ProdTermCeil
  • ProdTermFlr
  • ProdTermUnits
  • PurpCode
  • RateType
  • RegionCode

Loan Platform Product Search Behavior

The Loan Platform Product Search (LnPltfmProdSrch) service behavior is as follows.

Loan Platform Product Search is a documented filter/choice statement.

The Platform Account Type (PltfmAcctType) is the primary driver identifying either a loan or deposit search is being performed. This element allows the provider to direct the search message to the appropriate destination if loans and deposits are separate applications.

All filters selected work as an AND to further limit the response items as the user selects more filter choices.

LnPltfmProdSrchRq_MType

LnPltfmProdSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • LnTraitArray_AType
  • PltfmAcctTypeInfo_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

BrCode
The branch code.
CollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
OpenFlrAmt
The floor amount.
OpenCeilAmt
The ceiling amount.
PlnType
Tax plan types as approved by the IRS. Canonical values are:
  • EDU=Educational IRA
  • HSA=Health Savings
  • IRA=Regular IRA
  • MSA=Medical Savings
  • QRP=Keogh
  • RCV=ROTH Conversion
  • RTH=ROTH Retirement
  • SEP=Simplified Employer Plan
  • SIM=Simple Retirement
PltfmCatCode
The code that describes a grouping of products being offered. May be promotional or marketing related.
PltfmCustType
Identifies the type of customer. Canonical values are:
  • Bus
  • Indv
ProdTermFlr
The integer length of the term.
ProdTermCeil
The integer length of the term.
ProdTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
PurpCode
Bank-defined and is used to define the purpose of the loan.
RateType
Types of interest rates. Canonical values are:
  • Adj
  • Fix
  • Renew
  • Vrbl
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.

LnTraitArray_AType

LnTraitArray_AType is an array AType element. This is an array describing the characteristics that help define a loan product.

Contains:

  • LnTraitInfo_CType
LnTraitInfo_CType

LnTraitInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

LnTraitType
Elements describing the multitude of characteristics that help define a loan product. Canonical values are:
  • ARM
  • ARMConv
  • AutoPayOffer
  • ConstOnly
  • ConstPerm
  • CrBur
  • CrIns
  • Direct
  • Escrw
  • HELOC
  • IntitialRateOffer
  • PPOddDayInt
  • RE
  • Revol
  • RiskMgmt

PltfmAcctTypeInfo_CType

PltfmAcctTypeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PltfmAcctTypeCode
Types of platform products offered. Canonical values are:
  • Deposit
  • Loan
PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
PltfmClsfSecdType
Elements that further identify the type of Loan or Deposit instrument being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Secured,Unsecured. For example, if Deposit is selected for PltfmAcctTypeCode, then this field could be populated with Interest Bearing,Non Interest Bearing.

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.

LnPltfmProdSrchRs_MType

LnPltfmProdSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • LnTraitArray_AType
  • PltfmAcctTypeInfo_CType
  • PltfmProdSrchRecArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

BrCode
The branch code.
CollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
OpenCeilAmt
The ceiling amount.
OpenFlrAmt
The floor amount.
PlnType
Tax plan types as approved by the IRS. Canonical values are:
  • EDU=Educational IRA
  • HSA=Health Savings
  • IRA=Regular IRA
  • MSA=Medical Savings
  • QRP=Keogh
  • RCV=ROTH Conversion
  • RTH=ROTH Retirement
  • SEP=Simplified Employer Plan
  • SIM=Simple Retirement
PltfmCatCode
The code that describes a grouping of products being offered. May be promotional or marketing related.
PltfmCustType
Identifies the type of customer. Canonical values are:
  • Bus
  • Indv
ProdTermFlr
The integer length of the term.
ProdTermCeil
The integer length of the term.
ProdTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
PurpCode
Bank-defined and is used to define the purpose of the loan.
RateType
Types of interest rates. Canonical values are:
  • Adj
  • Fix
  • Renew
  • Vrbl
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.

LnTraitArray_AType

LnTraitArray_AType is an array AType element. This is an array describing the characteristics that help define a loan product.

Contains:

  • LnTraitInfo_CType
LnTraitInfo_CType

LnTraitInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

LnTraitType
Elements describing the multitude of characteristics that help define a loan product. Canonical values are:
  • ARM
  • ARMConv
  • AutoPayOffer
  • ConstOnly
  • ConstPerm
  • CrBur
  • CrIns
  • Direct
  • Escrw
  • HELOC
  • IntitialRateOffer
  • PPOddDayInt
  • RE
  • Revol
  • RiskMgmt

PltfmAcctTypeInfo_CType

PltfmAcctTypeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PltfmAcctTypeCode
Types of platform products offered. Canonical values are:
  • Deposit
  • Loan
PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
PltfmClsfSecdType
Elements that further identify the type of Loan or Deposit instrument being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Secured,Unsecured. For example, if Deposit is selected for PltfmAcctTypeCode, then this field could be populated with Interest Bearing,Non Interest Bearing.

PltfmProdSrchRecArray_AType

PltfmProdSrchRecArray_AType is an array AType element. This is an array of responses for a Platform Product Search.

Contains:

  • PltfmProdSrchRec_CType
PltfmProdSrchRec_CType

PltfmProdSrchRec_CType is a message MType element. This element purposefully includes complexes and elements related to both deposits and loans to support the possible existence of multiple platform providers at a single FI.

Contains:

  • PltfmSrchInfoRec_CType
Simple Elements

The following simple elements are contained within this complex.

BrDesc
A description of the branch name. It includes the Rstr attribute.
PltfmCatDesc
Platform Category Description - A long description of the PltfmCatCode.
PltfmProdDesc
Description of the type of account.
RegionDesc
The description of the code that identifies a financial institution's region that would encompass a group of branches.
PltfmSrchInfoRec_CType

PltfmSrchInfoRec_CType is a complex CType element.

Contains:

  • CollatCodeArray references CollatArray_AType
  • LnTraitArray_AType
  • PltfmAcctTypeInfo_CType
  • ProdTermArray_AType
  • PurpCodeArray references PurposeArray_AType
  • RateTypeArray_AType
Simple Elements

The following simple elements are contained within this complex.

BrCode
The branch code.
OpenCeilAmt
The ceiling amount.
OpenFlrAmt
The floor amount.
PlnType
Tax plan types as approved by the IRS. Canonical values are:
  • EDU=Educational IRA
  • HSA=Health Savings
  • IRA=Regular IRA
  • MSA=Medical Savings
  • QRP=Keogh
  • RCV=ROTH Conversion
  • RTH=ROTH Retirement
  • SEP=Simplified Employer Plan
  • SIM=Simple Retirement
PltfmCatCode
The code that describes a grouping of products being offered. May be promotional or marketing related.
PltfmCustType
Identifies the type of customer. Canonical values are:
  • Bus
  • Indv
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.
CollatCodeArray

CollatArray_AType is an array AType element. This is an array of items that can be used to collateralize a loan.

CollatCodeArray references CollatArray_AType.

Contains:

  • CollatInfo_CType
CollatInfo_CType

CollatInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
CollatDesc
The collateral code description.
LnTraitArray_AType

LnTraitArray_AType is an array AType element. This is an array describing the characteristics that help define a loan product.

Contains:

  • LnTraitInfo_CType
LnTraitInfo_CType

LnTraitInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

LnTraitType
Elements describing the multitude of characteristics that help define a loan product. Canonical values are:
  • ARM
  • ARMConv
  • AutoPayOffer
  • ConstOnly
  • ConstPerm
  • CrBur
  • CrIns
  • Direct
  • Escrw
  • HELOC
  • IntitialRateOffer
  • PPOddDayInt
  • RE
  • Revol
  • RiskMgmt
PltfmAcctTypeInfo_CType

PltfmAcctTypeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PltfmAcctTypeCode
Types of platform products offered. Canonical values are:
  • Deposit
  • Loan
PltfmClsfPrimType
Elements that further identify the type of loan or deposit products being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Mortgage,Auto,Commercial,Ag,Equipment. For example, if Deposit is selected as PltfmAcctTypeCode, then this field could be populated with Checking,Money Market,Savings,CD.
PltfmClsfSecdType
Elements that further identify the type of Loan or Deposit instrument being searched for. For example, if Loan is selected for PltfmAcctTypeCode, then this field could be populated with Secured,Unsecured. For example, if Deposit is selected for PltfmAcctTypeCode, then this field could be populated with Interest Bearing,Non Interest Bearing.
ProdTermArray_AType

ProdTermArray_AType is an array AType element. This is an array of product terms.

Contains:

  • ProdTermInfo_CType
ProdTermInfo_CType

ProdTermInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ProdTermCnt
The integer length of the term.
ProdTermType
The description of the product term. Canonical values are:
  • Ceil
  • Flr
ProdTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
PurpCodeArray

PurposeArray_AType is an AType element. This is an array of items identifying the purpose of a loan.

PurpCodeArray references PurposeArray_AType.

Contains:

  • PurposeInfo_CType
PurposeInfo_CType

PurposeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

PurpCode
Bank-defined and is used to define the purpose of the loan.
PurpDesc
The purpose code description.
RateTypeArray_AType

RateTypeArray_AType is an array AType element. This is an array of rate types.

Contains:

  • RateTypeInfo_CType
RateTypeInfo_CType

RateTypeInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

RateType
Types of interest rates. Canonical values are:
  • Adj
  • Fix
  • Renew
  • Vrbl
Note: The canonical values Adj, Fix, and Vrbl are supported for this service.

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