Multilevel Lending Tranche Relationship Addition
Multilevel Lending Tranche Relationship Addition
Multilevel Lending Tranche Relationship Addition is a jXchange service designed to allow consumers to add Multilevel Lending tranche relationships.
Message Flow
In jXchange, the Multilevel Lending Tranche Relationship Addition service uses
a typical exchange of MType
messages to allow consumers to add Multilevel Lending tranche relationships.
Primary Request
The consumer forwards the MLLTrancheRelAddRq_MType message to
the service provider.
The message contains the following complex elements:
Custom_CTypeMasterAcctIdreferencesAccountId_CTypeMsgRsHdr_CTypeTrancheAcctIdreferencesAccountId_CTypeTrancheAdd_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the MLLTrancheRelAddRs_MType
message to the consumer.
The message contains the following simple element:
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
Multilevel Tranche Relationship Addition Behavior
The Multilevel Lending Tranche Relationship Addition service behavior is as follows.
Multilevel Lending Tranche Relationship Add request
(MLLTrancheRelAddRq_MType) requires the Tranche Account Id
(TrancheAcctId), the Master Account Id
(MasterAcctId), and the Tranche Add complex
(TrancheAdd_CType). The Tranche Rec complex
(TrancheRec_CType) includes the Tranche Description/Remark
(TrancheRmkArray) and the Master Account Id
(MasterAcctId), which is also at the root level of the request. The
(MasterAcctId) within the complex is used on the Mod, but is not used
within the complex for the Add. Instead, it appears at the root and is required. The remaining
elements that were allowed during MLLTrancheRelAdd but differ from the master
and the tranche must be modified through
LnAcctMod/AcctMod.
MLLTrancheRelAddRq_MType
MLLTrancheRelAddRq_MType is a message MType element.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeMasterAcctIdreferencesAccountId_CTypeMsgRsHdr_CTypeTrancheAcctIdreferencesAccountId_CTypeTrancheAdd_CType
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.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
MasterAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
MasterAcctId 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
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 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_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.
TrancheAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
TrancheAcctId
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
TrancheAdd_CType
TrancheAdd_CType is a complex CType element.
Contains:
Custom_CTypeTrancheRec_CTypeTrancheInfoRec_CTypeTrancheAcctInfo_CTypeTranchePmtInfo_CTypeTrancheRateInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- LOCAcctId
- The account identification that is charged for fees from line of credit services.
- LOCCustId
- The customer identification for lines of credit.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TrancheAcctInfo_CType
TrancheAcctInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this message.
- ClsOnZeroBal
- Indicates if the account should be closed automatically when the
balance is at zero for the required number of days. Canonical values are:
- false
- true
- FirstPmtDt
- The first payment date.
- FundLmt
- The funding limit of a loan. The maximum amount that can be advanced on a loan.
- HldMailCode
- Includes the mailing instructions. Valid values are 1–9 or blank.
- PartIdNum
- The participation identification number.
- PrtBilNotCode
- Print billing notice indicates if the loan is to receive a billing notice.
- PrtcpAcctId
- The account ID of the master loan linked to the referenced loan.
- PrtcpAcctType
- The account type of the master loan linked to the referenced loan.
- PrtcpCode
- The code that references the participation position of the loan.
- PrtPastDueNotCode
- Print past due notice.
- StmtCycle
- The statement cycle.
- SynAgentId
- The ID of the syndicated agent responsible for the servicing of the loan.
- SynMemberId
- The ID of the syndicated member responsible for the servicing of the loan.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TrancheInfoRec_CType
TrancheInfoRec_MType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this message.
- AccrBilMthd
The accrual billing method. Canonical values are:
ActualSchedDueDt- Accruals billed as of the actual scheduled due date.BilDt- Accruals billed as of the billing date.DueDt- Accruals billed as of the due date.ThruActualSchedDueDt- Accruals billed through the actual scheduled due date.ThruDueDt- Accruals billed through the due date.
- AcctStat
- The account status.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- IntBasis
- The interest base method used for the loan. Canonical values
are:
- AddOn
- Amrtz
- Act/360
- Act/365
- 30/360
- 360/360
- IntRate
- The interest rate.
- MatDt
- The maturity date.
- OddDaysIntBasis
- The interest base to be used at the account's origination if it
differs from the
IntBasis. - OpenDt
- The date opened.
- OrigBal
- The original balance.
- 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
- RemPmtCnt
- The number of payments remaining.
- SemiDay1
- The day of month for first semi-monthly payment.
- SemiDay2
- The day of month for second semi-monthly payment.
- Term
- The term of the loan.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TranchePmtInfo_CType
TranchePmtInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this message.
- BilLeadDays
- The number of days before due date to print bills.
- CrtBilDOM
- The specific day of the month to create a loan bill/statement (rather than number of days before due date to print bills - BilLeadDays).
- FundSeqId
- The order in which advances on LOC are passed to participation sold loans.
- MinBilAmt
- The minimum amount due on a loan before a billing notice is created.
- NegAmrtzCapPct
- The negative amortization cap percentage. Must be 0 or greater than 100.
- PmtReAmrtzCap
- The payment reamortization cap.
- SplitPmtAsBil
Indicates if payments should be split as billed. Canonical values are:
- false
- true
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TrancheRateInfo_CType
TrancheRateInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this message.
- BusDayRateRevType
- Business or calendar days to look at for rate review changes.
Canonical values are:
- Prev - Previous business day
- Nxt - Next business day
- Cur - Current calendar day
- DaysBeforeRateChg
- The number of days before rate change.
- DaysInitARMNot
- The number of days before the initial adjustable-rate mortgage rate change notice should be sent.
- NonBusDayRateRevType
- Used when the rate review date falls on a non-processing day.
Canonical values are:
- Prev - Previous business day
- Nxt - Next business day
- NxtCurMonth - Next current month, which functions like next business day unless the non-processing day occurs at month-end, in which case the previous business day is used.
- OrigIdxVal
- The original index value. This index is used to calculate the original rate for ARM.
- PrtRateChgNotCode
- The code that designates the behavior for print rate change notices.
- RateCapDown
- The rate cap downward. The maximum downward change in the rate allowed during any rate cap term.
- RateCapRevDayOfMonth
- The day of the month for rate cap reviews. This code is only required if the rate cap review date is the 29th of the month.
- RateCapRevDt
- The rate cap review date.
- RateCapRevTerm
- The rate cap review term. The system checks the prime rate for change at the interval specified in this field. Entries may be in number of days or number of months.
- RateCapRevTermUnits
- The rate cap review term code. This field determines if the rate
cap period is to be figured in months or days.
Canonical values are:
- Days
- Months
- NA
- SemiMonthly
- Years
- RateCapUp
- The rate cap upward. The maximum upward change in the rate allowed during any rate cap term.
- RateCeil
- The rate ceiling entry that sets a top rate above which the rate never rises.
- RateFlr
- The rate floor entry that sets a base rate below which the rate of the loan never falls.
- RateIdxNum
- The rate index number to which the loan is tied.
- RateRevDayOfMonth
- The day of month for rate reviews. This code is only required if the rate review date is the 29th of the month.
- RateRevDt
- The date used to determine if a rate should be changed.
- RateRevTerm
- The rate review term. The system checks the prime rate for change at the interval specified in this field. Entries may be in number of days or number of months.
- RateRevTermUnits
- The rate review term code. This code determines whether the prime
review term is in months or days. Canonical values are:
- Days
- Month
- NA
- RateRoundMthd
- Rate rounding method. Method to round newly calculated rates.
- RateRoundToPct
- The rate rounded to percentage. Increment to round newly calculated rates.
- RateVarCode
- The rate variance code. This code tells the system if the
variance from prime is above, below, or is of a percentage. Canonical values
are:
- NA
- Negative
- Pct
- Positive
- RateVar
- The rate variance. The amount of variance from the prime rate allowed for the account.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TrancheRec_CType
TrancheRec_MType is a complex CType element.
Contains:
Custom_CTypeMasterActIdreferencesAccountId_CTypeTrancheRmkArrayreferencesRmk_AType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MasterAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
MasterAcctId 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
TrancheRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
TrancheRmkArray references Rmk_Atype.
Contains:
RmkInfo_CType
RmkInfo_CType
RmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Rmk
- Application or user remarks free-form text.
MLLTrancheRelAddRs_MType
MLLTrancheRelAddRs_MType is a message MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple element is contained within this message.
- RsStat
The status of the response. Canonical values are:
- fail
- success
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 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_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.
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.