Enterprise Solutions

Loan Bill Inquiry

Enterprise SOAP API > API by Reference > Core Services > Loan Bill Inquiry
Loan Bill Inquiry

Loan Bill Inquiry

Loan Bill Inquiry is a jXchange service designed to allow a consumer to inquire on loan billing information.

Message Flow

In jXchange, the Loan Bill Inquiry service uses a typical exchange of MType messages to allow a consumer to inquire on loan billing information.

Primary Request

The consumer forwards the LnBilInqRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntent
  • BilDueDt

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the LnBilInqRs_MType message to the consumer.

The message contains the following simple elements:

  • ActIntent
  • ActIntentKey

The message contains the following complex elements:

  • Custom_CType
  • LnBilRsInfoRec_CType
  • MsgRsHdr_CType

Loan Bill Inquiry Behavior

Loan Bill Addition is a jXchange service designed to allow a consumer to inquire on loan billing information.

The Loan Bill Inquiry root request message (LnBilInqRq_MType) requires the Account Identification complex (AcctId_CType) and Bill Due Date. The Activity Intention element is optional.

The Loan Bill Inquiry root response message (LnBilInqRs_MType) returns the Loan Bill Response Information Record complex (LnBilRsInfoRec_CType), Activity Intention element, and Activity Intention Key element. The Activity Intention element is an echo of the request optional. The Activity Intention Key element is conditionally returned based on the Activity Intention element value.

The service provider should adhere to the architectural guidelines for inquiry services.

LnBilInqRq_MType

LnBilInqRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

BilDueDt
The due date for a specific bill.

AccountId_CType

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

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

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request 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.

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.

LnBilInqRs_MType

LnBilInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • LnBilRsInfoRec_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnBilRsInfoRec_CType

LnBilRsInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • LnBilInfoRec_CType
  • SvcPrvdInfo references LnBilRsInfoRec_EType

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.
PrtBilNotDesc
The description of the code for print billing notice indicates if the loan is to receive a billing notice.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnBilInfoRec_CType

LnBilInfoRec_CType is a complex CType element.

Contains:

  • SvcPrvdInfo references LnBilInfoRec_EType
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.
PrtBilNotCode
Print billing notice indicates if the loan is to receive a billing notice.
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.
SvcPrvdInfo

LnBilInfoRec_EType is an extended EType element.

SvcPrvdInfo references LnBilInfoRec_EType.

SvcPrvdInfo

LnBilRsInfoRec_EType is an extended EType element.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

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.

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