Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Loan Unit Priced Addition

Enterprise SOAP API > API by Reference > Core Services > Loan Unit Priced Addition

Loan Unit Addition

Loan Unit Addition is a jXchange service designed to add loan units.

Message Flow

In jXchange, the Loan Unit Addition service uses a typical exchange of MType messages to add loan units.

Primary Request

The consumer forwards the LnUnitAddRq_MType message to the service provider.

The message contains the following simple element:

  • LnUnitId

The message contains the following complex elements:

  • AccountId_CType
  • Custome_CType
  • LnUnitAdd_CType
  • MsgRqHdr_CType

The message contains the following array:

  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the LnUnitAddRs_MType message to the consumer.

The message contains the following simple elements:

  • RsStat
  • LnUnitId

The message contains the following complex elements:

  • MsgRsHdr_CType
  • Custom_CType

LnUnitAddRq_MType

LnUnitAddRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • LnUnitAdd_CType
  • MsgRqHdr_CType

Simple Elements

The following simple element is contained within this message.

LnUnitId
The identification assigned to a unit of a loan.

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.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

LnUnitAdd_CType

LnUnitAdd_CType is a complex CType element.

Contains:

  • Custom_CType
  • LnUnitAcctInfo_CType
  • LnUnitBalDtInfo_CType
  • LnUnitInfoRec_CType
  • LnUnitPmtInfo_CType
  • LnUnitProtInfo_CType
  • LnUnitRateInfo_CType
  • LnUnitRealEstateInfo_CType
  • LnUnitRegRptInfo_CType
  • LnUnitRenExtInfo_CType

Simple Elements

The following simple element is contained within this complex.

LnUnitDesc
The description of an identification assigned to a unit of a loan.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LnUnitAcctInfo_CType

LnUnitAcctInfo_CType is a complex CType element.

Contains:

  • UserDefInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

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
CollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
MinBilAmt
The minimum amount due on a loan before a billing notice is created.
PrePmtPenCode
Pre-payment penalty code. If the loan is to assess a prepayment penalty on payoff, then enter the corresponding prepayment penalty parameter code.
PrtBilNotCode
Print billing notice indicates if the loan is to receive a billing notice.
PurpCode
Bank-defined and is used to define the purpose of the loan. Canonical values are:
  • CashOutRefi
  • HomeImprov
  • HomePurch
  • Oth
  • Refi
State
The two-character alpha code which represents a state. For example, MO.
TitleNeeded
Answers the question: Is the title still needed? This code is provided for bank use in tracking those loans for which a title to the collateral used for security is still needed. Canonical values are:
  • false
  • true
VehicleId
The Vehicle Identification Number.
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 UserDefCode represents.
UserDefDt
A date field that has a relationship with the UserDefTxt or UserDefCode.
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.

LnUnitBalDtInfo_CType

LnUnitBalDtInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

BalDueAtMat
The balance due at maturity. Canonical values are:
  • false
  • true
ClsDt
The closing date.
CollatInsurExpDt
The collateral insurance expiration date.
FeeChgdPYTD
The fees charged previous year-to-date.
FeeChgdYTD
The fees charged year-to-date.
FirstPmtDt
The first payment date.
IntChgdPYTD
The interest charged previous year-to-date.
IntChgdYTD
The interest charged year-to-date.
IntPaidLTD
The interest paid life-to-date.
IntPaidPYTD
The interest paid previous year-to-date.
IntPaidYTD
The interest paid year-to-date.
MinInt
The minimum interest.
NxtRvwDt
The next review date.
OrigFeesYTD
The origination fees year-to-date.
PrincPaidPYTD
The principal paid prior year-to-date.
PrincPaidYTD
The principal paid year-to-date.
UCCExpDt
The UCC expiration date.

LnUnitInfoRec_CType

LnUnitInfoRec_CType is a complex CType element.

Contains:

  • AcctTitleArray_AType
  • OffInfoArray_AType
  • Term_CType
Simple Elements

The following simple elements are contained within this complex.

AccrBal
The accrual balance.
AcctStat
The account status.
AvailCr
The available credit.
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.
LastPmtDt
The last payment date.
LateChgAmt
The late charge amount.
LnUnitMaster
Answers the question: Is the unit loan the master loan in a unit arrangement? Canonical values are:
  • false
  • true
LnUnitRptMthd
The method of reporting for unit loans. Canonical values are:
  • Dlr
  • MstrPln
  • UnitPrice
MatDt
The maturity date.
NxtPayDt
The next payment date.
NxtSchedPmtDt
The next scheduled payment date.
OpenDt
The date opened.
OrigBal
The original balance.
PartPmtAmt
The partial payment amount.
PastDueAmt
The past due amount.
PayoffGoodThruDt
The payoff good through 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
ProdCode

The code that identifies a product type of account within an application. Canonical values are:

  • jha-4sight
  • jha-argokeys
  • jha-cif2020
  • jha-coredirector
  • jha-imagecenter
  • jha-silverlake
  • jha-synapsys

ProdCode is a hybrid open enumeration.

SemiDay1
The day of month for first semi-monthly payment.
SemiDay2
The day of month for second semi-monthly payment.
AcctTitleArray_AType

AcctTitleArray_AType is an array AType element. This is an array of account titles used to define the customer and additional names. This element is optional.

Contains:

  • AcctTitleInfo_CType
AcctTitleInfo_CType

AcctTitleInfo_CType is a complex CType element.

Contains:

  • AddlName references PersonName_CType
  • AddlPhoneArray references PhoneArray_AType
  • AddlTIN references TINInfo_CType
Simple Elements

The following simple elements are contained within this complex.

AcctTitle
The account title including customer name and additional names.
Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
AddlBirthDt
The date of birth.
AddlNameStat
The additional person status. Canonical values are:
  • Act - active
  • NotAct - not active

The ComName element is contained by the AddlName complex and replaces the AcctTitle element. The depreciation effective date for AcctTitle is 2012-01-01.

AddlName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

AddlName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
AddlPhoneArray

PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.

AddlPhoneArray references PhoneArray_AType.

Contains:

  • PhoneInfo_CType
PhoneInfo_CType

PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.

Contains:
  • MobPhoneInfo_CType
Simple Elements

The following simple elements are contained within this complex.

ConEndTime
The Greenwich Mean time when contact availability ends.
ConStartTime
The Greenwich Mean time when contact availability starts.
PhoneExt
The phone extension.
PhoneNumDsp
Phone Number Display, based on format codes which may include special formatting. Examples include:
  • (XXX)XXX-XXXX
  • XXX-XXX-XXXX
  • XXX/XXX/XXXX
  • XXX.XXX.XXXX
  • XXX-XXX-XXXXXX
  • XXXXX-XXX-XXX-XXXX
PhoneNum
The phone number.
PhoneTime
Best phone usage time, day, or evening.
PhoneType

Phone type examples are: home, work, fax, cell. Canonical values are:

  • Home
  • SecdHome
  • Bus
  • SecdBus
  • HomeCell
  • BusCell
  • PersonalCell
  • HomeFax
  • BusFax
  • SecdBusCell

PhoneType is a hybrid open enumeration.

AddlTIN

TINInfo_CType is a complex CType element. This element contains tax information number codes and descriptions. This element is optional.

AddlTIN references TINInfo_CType.

Contains:

  • TaxIdOwnerName references PersonName_CType
Simple Elements

The following simple elements are contained within this complex.

BNotIRSDt
The last IRS notification.
BNotStat
The B notice flag.
CertCodeDesc
The description of the code that represents the certification behavior for a tax ID.
CertCodeDt
The certification code date.
CertCode
The code that represents the certification behavior for a tax ID.
TaxIdMod
A tax ID modifier assigned by the SSA to some individuals.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
TINCode
The code that designates the type of tax identification number. Canonical values are:
  • SSN
  • EIN
  • Forn

TINCode is a hybrid open enumeration.

TINDesc
The description of the code that designates the type of tax identification number.
TaxIdOwnerName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

TaxIdOwnerName references PersonName_CType.

The TaxIdOwnerName is optional and is only required when the customer level tax ID is different than the account level.

Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
OffInfoArray_AType

OffInfoArray_AType is an array AType element. This is an array of officers.

Contains:

  • OffInfoRec_CType
OffInfoRec_CType

OffInfoRec_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

OffCode
The code that designates the financial institution officer.
OffCodeText
The text that describes the preceding elements for the OffInfoArry.
OffDesc
The officer short name.
OffRmk
Application or user remarks free-form text.
Term_CType

Term_CType is a complex CType element. This complex contains loan account term information. This element is optional.

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

LnUnitPmtInfo_CType

LnUnitPmtInfo_CType is a complex CType element.

Contains:

  • LnFeeArray_AType
Simple Elements

The following simple elements are contained within this complex.

BilIntAmt
The billed interest amount.
BilLateChgAmt
The billed late charge.
BilLeadDays
The number of days before due date to print bills.
BilOtherChgAmt
The billed other charge amount.
BilPrincAmt
The billed principal.
ChgYrFeeCode
The code that describes the behavior of how a yearly fee should be charged. For example, skip the first year.
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).
LastPmtAmt
The last payment amount.
NSFFeeAmt
The NSF fee amount.
OthChgAmt
Other charges.
PrePmtPenLTD
The pre-payment penalty life-to-date.
PrePmtPenPYTD
The pre-payment penalty previous year-to-date.
PrePmtPenYTD
The pre-payment penalty year-to-date.
SecdAccr
The secondary accrual.
UnitPostSeq
Posting sequence for system split payments.
UnpaidChgs
The unpaid charges.
LnFeeArray_AType

LnFeeArray_AType is an array AType element.

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.

LnUnitProtInfo_CType

LnUnitProtInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DrAcctId
The debit account number.
DrAcctType
The debit account type.
LastAdvaAmt
The amount of the last loan advance.
LastAdvaDt
The last advance date
MinAdvaAmt
The minimum amount that a loan is allowed to advance.

LnUnitRateInfo_CType

LnUnitRateInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DaysBeforeRateChg
The number of days before rate change.
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.

LnUnitRealEstateInfo_CType

LnUnitRealEstateInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex:

ApprDt
The last appraisal date of the account.
ApprVal
Used for bank informational purposes in tracking appraised value of collateral.

LnUnitRegRptInfo_CType

LnUnitRegRptInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CallRptCode
The call report code.

LnUnitRenExtInfo_CType

LnUnitRenExtInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ExtFeesLTD
The extension fees life-to-date.
ExtFeesMTD
The extension fees month-to-date.
ExtFeesYTD
The extension fees year-to-date.
ExtMonthsLTD
The number of months extended life-to-date.
LastExtDt
The last extension date.
LastRenDt
The date of last renewal.
NumPmtsExtLastYr
The number of payments extended last year.
NumPmtsExtLTD
The number of payments extended life-to-date.
NumPmtsExtYTD
The number of payments extended year-to-date.
PrevExtDt
The date of previous extension.
PrevRenDt
The date of previous renewal.
RenCntLTD
The number of times renewed life-to-date.
TimesExtLTD
The number of extensions life-to-date.
TimesRenPrevYr
The number of times renewed last year.
TimesRenYTD
The number of times renewed this year.

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.

LnUnitAddRs_MType

LnUnitAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

LnUnitId
The identification assigned to a unit of a loan.
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_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 Wed Oct 30 2024