Loan Renewal
Loan Renewal is a jXchange messaging service designed to renew a loan prior to the contractual maturity date.
Message Flow
Message flow involves the exchange of
MType complexes between
the Third Party Consumer and the Service Provider.
Primary Request
The Third Party Consumer forwards the
LnRenRq_MType complex to
the Service Provider containing:
ErrOvrRdInfoArray_ATypeAccountId_CTypeLnPmtExtInfo_CType
Primary Response
The Service Provider returns the
LnRenRs_MType message
containing:
CondNotfArray_ATypeRsStat_Type
Behavior
The account identification is required.
The loan renewal information complex contains the elements specific to the loan renewal service. This is a required complex.
The response includes the condition notification array to convey to the consumer the other services that might need to be requested to complete the loan renewal.
The Service Provider should return a fault if a renewal already exists for the loan that would allow the consumer to return the message with an override. The Service Provider will then overwrite the previous renewal.
The Service Provider could aggregate their existing Business Service for loan modifications for the loan renewal services as this service is a simplified version of the modification service.
Loan Renewal Business Case
In this example, a consumer is renewing a loan.
The consumer sends the LnRenRq message to the Service
Provider with the following values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
AccountId | AcctId | 5551234555123456 |
AcctType | L |
| Complex Element | Simple Element | Entry Value |
|---|---|---|
LnRenInfo | NxtPayDt | 2009–05–27 |
PmtDayOfMonth | 27 | |
PmtTerm | Days | |
PmtTermUnits | 30 | |
PmtCode | 2 | |
PIAmt | 825.97 | |
PmtAmt | 825.97 | |
MatDt | 2010–04–27 | |
IntRate | 7.25 | |
LnTerm | TermCnt | 1 |
TermUnits | Years | |
Desc | Renew the loan for another year. | |
EffDt | 2009-04-27 |
The Service Provider returns the RsStat with a status of
Success.
LnRenRq_MType
LnRenRq_MType is a message
MType element.
Contains:
AccountId_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeLnRenInfo_CTypeMsgRqHdr_CType
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.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array
AType element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_CType is a complex CType element. This
element is used to override errors created in a previous request. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- ErrCode
- The Soap Header Fault error code.
LnRenInfo_CType
LnRenInfo_CType is a complex
CType element.
Contains:
LnTermreferencesTerm_CType
Simple Elements
The simple elements contained within this complex are listed below.
- EffDt
- The date assigned to transactions when it is different from the posting date.
- IntRate
- The interest rate.
- MatDt
- The maturity date.
- NxtPayDt
- The next payment date.
- PIAmt
- The principal and interest payment amount.
- PmtAmt
- The payment amount.
- PmtCode
- The payment code. The payment code determines how the payment is applied to the loan.
- PmtDayOfMonth
- The day of month for payment. This code is only required if the payment due date is the 29th of the month.
- PmtTerm
- The payment frequency.
- PmtTermUnits
- The payment frequency units: months, days. Canonical values are:
- AtMat
- Days
- Months
- NA
- SemiMonthly
- Years
- SemiDay1
- The day of month for first semi-monthly payment.
- SemiDay2
- The day of month for second semi-monthly payment.
LnTerm
Term_CType is a complex
CType element. This complex contains loan account term
information. This element is optional.
This element
references Term_CType.
Simple Elements
The following simple elements are contained within this complex.
- DaysCall
- The notice and number of business days required for withdrawal. Required if TermUnits is set to Indefinite.
- Desc
- The generic description.
- TermCnt
- The integer length of the term.
- TermUnits
- The term units: years, months, days, indefinite. Canonical values
are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is the default
message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-Security.
LnRenRs_MType
LnRenRs_MType is a message
MType element.
Contains:
CondNotfArray_ATypeCustom_CTypeMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- RsStat
- The status of the response. Canonical values are:
- Fail
- Success
CondNotfArray_AType
CondNotfArray_AType is an array
AType element. This is an array of condition notifiers used
to define conditional notification status.
Contains:
CondNotfInfo_CType
CondNotfInfo_CType
CondNotfInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- CondNotf
- The conditions that exist on an account or customer to notify the consumer to use
another service. Canonical values:
- AcctAnlys
- AcctCombStmt
- AcctProdOvrrd
- AcctSweep
- AddrAcct
- AddrIRSRpt
- AddrNot
- AddrOvrrd
- AddrPmts
- AddrSeasonal
- AddrStmt
- AlertMsg
- CollatMsg
- CollatTrack
- ColMsg
- Escrw
- FASB91
- FraudAlert
- LnPmtSched
- LnRateSched
- LnUnit
- LineOfCr
- MemoPost
- Msg
- ODProt
- PlnBenf
- RealEstateProp
- StopAlerts
- StopHold
- StopPay
- Stops
- StopSpecInstr
- TimeDepRenOvrrd
- XferACH
- XferFut
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-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.