Enterprise Solutions

Loan Bill Information Search

Enterprise SOAP API > API by Reference > Core Services > Loan Bill Information Search
Loan Bill Information Search

Loan Bill Information Search

Loan Bill Information Search is a jXchange service designed to provide the consumer with the ability to integrate bills created for a loan.

Message Flow

In jXchange, the Loan Bill Information Search service uses a typical exchange of MType messages to allow consumers to integrate bills created for a loan.

Primary Request

The third-party consumer forwards the LnBilSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • EndDt
  • IncPaidBil
  • StartDt

The message contains the following complex elements:

  • Custom_CType
  • InAcctId references AccountId_CType
  • SrchMsgRqHdr_CType

Primary Response

The service provider returns the LnBilSrchRs_MType message to the third-party consumer.

The message contains the following simple elements:

  • EndDt
  • IncPaidBil
  • StartDt

The message contains the following complex elements:

  • Custom_CType
  • InAcctId references AccountId_CType
  • SrchMsgRsHdr_CType

The message contains the following array:

  • LnBilSrchRecArray_AType

Loan Bill Information Search Behavior

The Loan Bill Information Search service returns all the bills related to a specific account identification. The AccountId_CType complex is required in the request. The LnBilSrchRq_MType request message provides the consumer a means to filter for specific bills. The date filters use the BilDueDt element for comparisons. A consumer request with a StartDt and without an EndDt returns all the qualified bills with a date equal to and greater than the StartDt. A consumer request with an EndDt and without a StartDt returns all the qualified bills with a date less than the EndDt.

The IncPaidBil element is optional and allows a consumer to request bills that have been satisfied in the response set. The default value is ~false~.

The elements in the LnBilSrchRq_MType root request message are echoed in the LnBilSrchRs_MType root response message.

LnBilSrchRq_MType

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

EndDt
The date that designates the ending point for date selections.
IncPaidBil
Include paid bills when searching for bills. Canonical values are:
  • false
  • true
StartDt
The date that designates the starting point for date selections.

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

LnBilSrchRs_MType

LnBilSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • LnBilSrchRecArray_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.
IncPaidBil
Include paid bills when searching for bills. Canonical values are:
  • false
  • true
StartDt
The date that designates the starting point for date selections.

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

LnBilSrchRecArray_AType

LnBilSrchRecArray_AType is an array AType element. This is an array of responses for the Loan Bill Search service.

Contains:

  • LnBilSrchRec_CType

LnBilSrchRec_CType

LnBilSrchRec_CType is a complex CType element.

Contains:

  • CustomLnBilSrchRec references Custom_CType
  • LnBilInfoRec_CType
Simple Elements

The following simple elements are contained within this complex.

BilCrtDt
The date a bill was created.
BilDueDt
The due date for a specific bill.
PrtBilNotCode
Print billing notice indicates if the loan is to receive a billing notice.
CustomLnBilSrchRec

Custom_CType is a complex CType element.

CustomLnBilSrchRec references Custom_CType.

This element is optional.

LnBilInfoRec_CType

LnBilInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

BilAHAmt
The billed credit life insurance amount.
BilCrLifeAmt
The billed credit life insurance amount.
BilEscrwAmt
The billed escrow amount.
BilIntAmt
The billed interest amount.
BilLateChgAmt
The billed late charge.
BilOtherChgAmt
The billed other charge amount.
BilPaidDt
The date a bill was satisfied.
BilPrincAmt
The billed principal.
BilUEInsurAmt
Billed unemployment insurance.
RemBilAHAmt
The amount not satisfied for billed accident and health insurance amount.
RemBilCrLifeAmt
The amount not satisfied for billed credit life insurance amount.
RemBilEscrwAmt
The amount not satisfied for billed escrow amount.
RemBilIntAmt
The amount not satisfied for billed interest amount.
RemBilLateChgAmt
The amount not satisfied for billed late charge amount.
RemBilOtherChgAmt
The amount not satisfied for billed other charge amount.
RemBilPrincAmt
The amount not satisfied for billed principal amount.
RemUEInsurAmt
Remaining balance of a billed unemployment insurance.
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