Loan Fee Search

Loan Fee Search is a jXchange service designed to allow consumers to search for fees related to a specific account identification.

Message Flow

In jXchange, Loan Fee Search uses a typical exchange of MType messages to allow consumers to search for fees related to a specific account identification.

Primary Request

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

  • EndDt
  • FeeSched
  • IncPaidFee
  • LnFeeCode
  • LnUnitUd
  • StartDt

Primary Response

The service provider returns the LnFeeSrchRs_MType message to the consumer. The message contains the following simple elements:

  • EndDt
  • FeeSched
  • IncPaidFee
  • LnFeeCode
  • LnUnitId
  • StartDt

Loan Fee Search Behavior

The Loan Fee Search (LnFeeSrch) operation behavior is as follows.

Loan Fee Search provides consumers a way of searching for fees related to a specific account identification.

The Loan Fee Search root request message (LnFeeSrchRq_MType) requires a Loan Account Identification LnAcctId simple element. The Loan Fee Search root request optionally includes a documented filter statement, which allows the consumer to filter by Loan Unit Identification LnUnitId, Loan Fee Code LnFeeCode, Fee Schedule FeeSched, Start Date StartDt, End Date EndDt, and Include Paid Fee IncPaidFee simple elements.

A consumer request with an start date, without an end date returns all the qualified fees with a fee next payment date equal to and greater than the start date.

A consumer request with an end date, without a start date, returns all the qualified fees with a fee next payment date equal to and less than the effective date.

A consumer request with an start date and an end date returns all the qualified fees with a fee next payment date equal to and greater than a start date and a date equal to and less than the end date.

The service provider reserves the right to limit the date range when a consumer's request does not include a Start Date and End Date.

The Include Paid Fee IncPaidFee simple element allows a consumer to request fees that have been satisfied in the response set. The default value is false.

The Loan Fee Search root response (LnFeeSrchRs_MType) echoes back the filter values submitted on the request along with a Loan Fee Search Record Array (LnFeeSrchRecArray_AType).

The Loan Fee Search Record Array (LnFeeSrchRecArray_AType) includes a Loan Fee Search Record complex (LnFeeSrchRec_CType) which encapsulates the Loan Account Identification LnAcctId, Loan Fee Identification LnFeeId, Loan Unit Identification LnUnitId, Loan Unit Description LnUnitDesc, Loan Fee Code LnFeeCode, Loan Fee Description LnFeeDesc, and Loan Fee Amount LnFeeAmt simple elements.

The standard search message header tenets are applicable.

The standard search message tenets are applicable.

LnFeeSrchRq_MType

LnFeeSrchRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

EndDt
The date that designates the ending point for date selections.
FeeSched
A filter used to determine the behavior when searching for fees that have a schedule. Canonical values are:
  • True
  • False
IncPaidFee
Include paid fees when searching for fees. Canonical values are:
  • true
  • false
  • The default value is false.
LnFeeCode
The code that describes the details of charging a loan fee.
LnUnitId
The identification assigned to a unit of a loan.
StartDt
The date that designates the starting point for date selections.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnAcctId

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

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

LnFeeSrchRs MType

LnFeeSrchRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • LnFeeSrchRecArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

EndDt
The date that designates the ending point for date selections.
FeeSched
A filter used to determine the behavior when searching for fees that have a schedule. Canonical values are:
  • True
  • False
IncPaidFee
Include paid fees when searching for fees. Canonical values are:
  • true
  • false
  • The default value is false.
LnFeeCode
The code that describes the details of charging a loan fee.
LnUnitId
The identification assigned to a unit of a loan.
StartDt
The date that designates the starting point for date selections.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnAcctId

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

LnAcctId 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

LnFeeSrchRecArray_AType

LnFeeSrchRecArray_AType is an array AType element. This is the array of responses for Loan Fee Search.

Contains:

  • LnFeeSrchRec_CType
LnFeeSrchRec_CType

LnFeeSrchRec_CType is a complex CType element.

Contains:

  • LnAcctId references AccountId_CType.
Simple Elements

The following simple elements are contained within this complex.

LnFeeAmt
The amount of specific loan fees collected.
LnFeeAssmntDt
The date the loan fee assessment should occur.
LnFeeCode
The code that describes the details of charging a loan fee.
LnFeeDesc
The description of the code that describes the details of charging a loan fee.
LnFeeFreq
The frequency of the loan fee assessment.
LnFeeFreqUnits
The units of frequency for the loan fee assessment. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
LnFeeId
A unique identifier given to a loan fee.
LnUnitDesc
The description of an identification assigned to a unit of a loan.
LnUnitId
The identification assigned to a unit of a loan.
NxtPayDt
The next payment date.
LnAcctId

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

LnAcctId 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

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