Line of Credit Add
LOC Addition
LOC Addition is a jXchange service designed to establish a line of credit
using a LOCAddRq and a LOCRec to establish line of credit
(LOC) values.
Message Flow
In jXchange, the LOC Addition service uses a typical exchange of MType messages to establish a line
of credit using a LOCAddRq and a LOCRec to establish LOC
values.
Primary Request
The third-party consumer forwards the LOCAddRq_MType message to the
service provider.
The message contains the following simple elements:
- LOCAcctId
- LOCAcctType
- LOCCustId
The message contains the following complex elements:
Custom_CTypeLOCRec_CTypeMsgRqHdr_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the LOCAddRs_MType message to the
third-party consumer.
The message contains the following simple element:
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
LOCAddRq_MType
LOCAddRq_MType is a message
MType element.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeLOCRec_CTypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- LOCAcctId
- The account identification that is charged for fees from line of credit services.
- LOCAcctType
- The account type 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.
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.
LOCRec_CType
LOCRec_CType is a complex CType element.
Contains:
ConstInProcArray_ATypeLOCFeeArrayreferencesLnFeeArray_ATypeLOCQtrAmtInfoArray_ATypeUserDefInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- LOCAmt
- The amount of the credit line.
- LOCAvgLTD
- The average balance of the credit line over the life of the line.
- LOCAvg
- The credit line average usage.
- LOCAvlBal
- The outstanding available balance of the line of credit.
- LOCAvlCalcType
- Defines the availability calculation method for credit lines. The
canonical values are:
LOCAmt- Credit Line AmountLOCCurBal- Loan Balance
- LOCBankNetTot
- The lead account credit line value amount.
- LOCBrCode
- The branch code.
- LOCCallRptCode
- The call report code.
- LOCClsCode
- The code that designates the reason the line of credit was closed.
- LOCCode
- The code that defines the type of line of credit.
- LOCCollatCode
- The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
- LOCCommBal
- The outstanding committed funds of the line of credit.
- LOCCurBal
- The outstanding balance of the line of credit.
- LOCDDAProtAmt
- The threshold balance of the deposit account before the line of credit creates any advance.
- LOCExpDt
- The line of credit expiration date.
- LOCFeeAcctId
- The account identification that is charged for fees from line of credit services.
- LOCFeeAcctType
- The account type that is charged for fees from line of credit services.
- LOCFrzAmt
- The amount of the credit line that should be frozen, disallowing advances.
- LOCGdnceBorwAck
Answers the question: Has the line of credit borrower acknowledge the guidance? Canonical values are:
- false
- true
The default value is false.
- LOCGdnceRedType
Answers the question: What balance is used for the reduction to the line of credit level balance? Canonical values are:
- AvlBal
- LOCAmt
The default value is LOCAmt.
- LOCGdnceType
Answers the question: Does the line of credit subject to guidance? Canonical values are:
- false
- true
The default value is false.
- LOCHighAmtDt
- The date the high credit line balance was obtained.
- LOCHighAmtLTD
- The high balance of the credit line over the life of the line.
- LOCHighAmt
- The credit line high usage.
- LOCInfo
- Any information pertinent to the line of credit.
- LOCLastMainDt
- The last maintenance date.
- LOCLastRedDt
- The last line of credit reduction date.
- LOCLastStmtDt
- The last statement date.
- LOCLowAmtDt
- The date the low credit line balance was obtained.
- LOCLowAmtLTD
- The low balance of the credit line over the life of the line.
- LOCLowAmt
- The line of credit low usage.
- LOCMainLOCId
- The sub line of credit main credit line account.
- LOCNxtRedDt
- The next schedule line of credit reduction date.
- LOCOffCode
- The code that designates the financial institution officer.
- LOCOrigAmt
- The original amount of the credit line.
- LOCOrigTerm
- The original integer value of the term of the credit line.
- LOCOrigTermUnit
- The original credit line term. Canonical values are:
- Days
- Months
- SemiMonthly
- Years
- LOCPrtCnsldtStmt
- Should a consolidated statement be printed?
- LOCPrtcpCode
- The code that defines the line of credits participation activity.
- LOCRedPct
- The percentage amount that a line of credit should be reduced.
- LOCRedRvwFreq
- The frequency the line of credit is reviewed for reduction activity.
- LOCRedRvwFreqUnits
- The units of frequency for the line of credit review frequency.
Canonical values are:
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- Years
- LOCRegAvlBal
- The available balance of the line of credit for regulatory reporting.
- LOCRiskCode
- The code that defines the risk associated with this line of credit for accurate regulatory reporting schedules.
- LOCSchedRedAmt
- The scheduled amount for a line of credit reduction.
- LOCSemiDay1
- The day of month for first semi-monthly payment.
- LOCSemiDay2
- The day of month for second semi-monthly payment.
- LOCStat
- The status of the line of credit.
- LOCStmtDay
- The statement day.
- LOCStmtFreqCode
- The statement frequency code.
- LOCStmtFreq
- The statement frequency.
- LOCTaxRefId
- The credit line tax reference number. Tax reference number for credit line. For informational purposes.
- LOCTotAdvaAmt
- The credit line total advances.
- LtrOfCrLmt
- The line of credit limit.
- MaxTrancheCrtCnt
- The total count of records.
- MLLIncCombStmt
Include on combined statement? Indicates if this account is to be included in combined statement information. Canonical values are:
- false
- true
LOCFeeArray
LnFeeArray_AType is an array
AType element.
LOCFeeArray references LnFeeArray_AType.
Contains:
LnFeeInfoRec_CType
LnFeeInfoRec_CType
LnFeeInfoRec_CType is a complex
CType element.
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.
- LnFeeCaplze
- Answers the question: Are the loan fees being capitalized? Canonical
values are:
- false
- true
- LnFeeChgCode
- The code that describes the behavior for charging a fee. Canonical
values are:
- Chg
- NA
- Wav
- LnFeeCode
- The code that describes the details of charging a loan fee.
- LnFeeDayOfMonth
- The day of month for loan fee assessment. This day is only required if the loan fee assessment date is the 29th of the month.
- 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.
- LnFeeLastPmtDt
- The last payment date.
- LnFeeNxtPayDt
- The next payment date.
- LnFeeRemAmt
- The remaining amount of the loan fee that needs to be collected.
- LnFeeStat
- The status of the loan fee. Canonical values are:
- Act
- Canc
- Exp
- Susp
- LnFeeText
- The text that describes the loan fee element that precedes it in
the
LnFeeArray.
ConstInProcArray_AType
ConstInProcArray_AType is an array
AType element. This is an array of the distribution line
items for a construction loan.
Contains:
ConstInProcRec_CType
ConstInProcRec_CType
ConstInProcRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- BdgCode
- A code that designates the type of budget line item.
- BdgDesc
- The description of the code that designates the type of budget line item.
- BdgDisbAmt
- The amount of disbursed funds for a budget item.
- BdgRtnAmt
- The amount that should be retained for a budget line item.
- BdgRtnPct
- The percentage that should be retained for a budget line item.
- CurBdgAmt
- The current budget amount allocated to a budget line item.
- DisbCmpltPct
- The percentage of completion for a specific distribution amount for a budget line item.
- DisbDftBdgAmt
- The default budget amount based on the budget line item.
- InspLastDt
- The last property inspection date.
- OrigBdgAmt
- The original budget amount before any budget adjustments.
LOCQtrAmtInfoArray_AType
LOCQtrAmtInfoArray_AType is an array AType element. This is an array of calendar quarter amounts as related to line of
credit accounts.
Contains:
LOCQtrAmtInfoRec_CType
LOCQtrAmtInfoRec_CType
LOCQtrAmtInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- QtrAdvaAmt
- The quarterly advance amount.
- QtrAvgBalAmt
- The quarterly average balance amount.
- QtrBegDt
- The beginning date that equates to the start of the quarter.
- QtrEndDt
- The ending date that equates to the start of the quarter.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
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.
LOCAddRs_MType
LOCAddRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are 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.