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

Escrow Add

Enterprise SOAP API > API by Reference > Core Services > Escrow Add

Escrow Add

Escrow Add is a jXchange service used for the exchange of web service messages in order for a Third Party Consumer to add an escrow account on a Service Provider.

Message Flow

Escrow Add is typical of most jXchange services, using MType complexes to pass information between Third Party Consumers and Service Providers.

Primary Request

The Third Party Consumer forwards the EscrwAddRq_MType complex element to the Service Provider containing complexes defining the escrow account to be added, such as EscrInfoRec_CType and EscrwPmtBalInfoRec_CType. In addition, the request also includes the EscrwTypeCode, which designates the type of escrow record, such as insurance, taxes, etc.

Primary Response

The Service Provider returns the EscrwAddRs_MType complex element to the Third Party Consumer containing the optional EscrwId element to identify the newly created escrow account, and the RsStat element, stating if the requested addition was successful.

EscrwAddRq_MType

EscrwAddRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • EscrwAnlysInfoRec_CType
  • EscrwFedWith references FedWith_CType
  • EscrwInfoRec_CType
  • EscrwPmtBalInfoRec_CType
  • EscrwStateWith references StateWith_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

EscrwTypeCode
The code that designates the type of escrow record. For example, insurance or taxes.

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.

EscrwAnlysInfoRec_CType

EscrwAnlysInfoRec_CType is a complex CType element.

Contains:

  • EscrwAnlysArray_AType

Simple Elements

The following simple elements are contained within this complex.

EscrwAnlysCusCode
The code that describes if the allowable cushion should be used for escrow analysis.
EscrwARMNotCode
The code that determines if the escrow analysis statement should print with the ARM rate change notice.
EscrwBegStmtTerm
The time to wait before producing the initial escrow statement.
EscrwBegStmtTermUnit
The time unit to wait before producing the initial escrow statement. Canonical values are:
  • Days
  • Months
  • NA
  • Years
EscrwChgPmtAmt
The escrow payment amount threshold to determine if the payment amount should be changed.
EscrwCushMos
The number of cushion months to provide for escrow analysis.
EscrwDefcGEPmtCode
The code that decides the action to be taken when the escrow account deficiency is greater than or equal to one escrow payment.
EscrwDefcLTPmtCode
The code that decides the action to be taken when the escrow account deficiency is less than one escrow payment.
EscrwNonAccrCode
The code that describes the action to be taken on nonaccrual loans for escrow analysis.
EscrwNxtAnlysDt
The next escrow analysis date.
EscrwPrtChkAmt
The threshold amount to determine if an escrow overage check should be produced.
EscrwPrtChkPct
The percentage to determine if an escrow overage check should be produced.
EscrwRoundMthd
The new payment rounding method. The method to round newly calculated escrow payments. Canonical values are:
  • (*) - Blank
  • (D) - Down
  • (N) - Nearest
  • (U) - Up
EscrwShtGEPmtCode
The code that decides the action to be taken when the escrow account shortage is greater than or equal to one escrow payment.
EscrwShtLTPmtCode
The code that decides the action to be taken when the escrow account shortage is less than one escrow payment.

EscrwAnlysArray_AType

EscrwAnlysArray_AType is an array AType element. This is an array of escrow analysis settings.

Contains:

  • EscrwAnlysInfo_CType
EscrwAnlysInfo_CType

EscrwAnlysInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EscrwDefcGEPmtAmt
The threshold deficiency amount when the deficiency is greater than or equal to one escrow payment.
EscrwDefcGEPmtTerm
The amount of time to spread any escrow deficiency when the deficiency is greater than or equal to one escrow payment.
EscrwDefcGEPmtTermUnit
The time unit to spread any escrow deficiency when the deficiency is greater than or equal to one escrow payment. Canonical values are:
  • Days
  • Months
  • NA
  • Years
EscrwDefcLTPmtAmt
The threshold deficiency amount when the deficiency is less than one escrow payment.
EscrwDefcLTPmtTerm
The amount of time to spread any escrow deficiency when the deficiency is less than one escrow payment.
EscrwDefcLTPmtTermUnit
The time unit to spread any escrow deficiency when the deficiency is less than one escrow payment. Canonical values are:
  • Days
  • Months
  • NA
  • Years
EscrwShtGEPmtTerm
The amount of time to spread any escrow shortage when the shortage is greater than or equal to one escrow payment.
EscrwShtLTPmtAmt
The threshold shortage amount when the shortage is less than one escrow payment.
EscrwShtLTPmtTerm
The amount of time to spread any escrow shortage when the shortage is less than one escrow payment.
EscrwShtLTPmtTermUnit
The time unit to spread any escrow shortage when the shortage is less than one escrow payment. Canonical values are:
  • Days
  • Months
  • NA
  • Years

EscrwFedWith

FedWith_CType is a complex CType element. This element contains federal tax withholding information. This element is optional.

EscrwFedWith references FedWith_CType.

Simple Elements

The following simple elements are contained within this complex.

FedWithAltAcctId
The federal withholding alternate account number.
FedWithAltAcctType
The federal withholding alternate account type.
FedWithAltRate
The federal withholding alternate rate.
FedWithCode
The federal withholding code passed from the service of record during the pilot phase.
FedWithCycleAmt
The federal withholding current cycle amount.
FedWithDesc
The federal withholding code description.
FedWithEffDt
The federal withholding effective date.
FedWithFixAmt
The federal withholding fixed holding amount.
FedWithLastYR
The federal withholding last year.
FedWithMTD
The federal withholding month-to-date.
FedWithQTD
The federal withholding quarter-to-date.
FedWithYTD
The federal withholding year-to-date.

EscrwInfoRec_CType

EscrwInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CurPMILTVRatio
The current lone-to-value ratio used for Private Mortgage Insurance (PMI).
EscrwDistrAmt
The amount of the next distribution for a specific escrow fund.
EscrwDistrDOM
The day of the month the escrow funds are distributed.
EscrwDistrDt
The date of the next distribution for a specific escrow fund.
EscrwDistrRate
The rate of the next distribution for a specific escrow fund.
EscrwDistrStartDt
The date of the initial distribution for a specific escrow fund.
EscrwDistrTaxAmt
The amount of the next distribution for a specific escrow tax fund.
EscrwDistrTaxRate
The rate of the next distribution for a specific escrow tax fund.
EscrwDistrTerm
The term (frequency) the escrow funds are distributed.
EscrwDistrTermUnit
Term units. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
EscrwLastDistrAmt
The last amount of the escrow funds distributed.
EscrwLastDistrDt
The last date of the escrow funds distributed.
EscrwLastDistrRate
The last amount rate of the escrow funds distributed.
EscrwLastDistrTaxAmt
The last tax amount of the escrow funds distributed.
EscrwLastDistrTaxRate
The last tax amount rate of the escrow funds distributed.
EscrwPayeeCode
The code that designates the payee for the escrow funds that are distributed.
EscrwPmtAgentCode
The code that represents the agent who should receive payment from the escrow funds.
EscrwPmtCompCode
The code that represents the company who should receive payment from the escrow funds.
EscrwPmtStartDt
The date of the initial payment for a specific escrow fund.
EscrwPrtNotCode
The code that designates the behavior of escrow distribution notices.
EscrwPrvdPropType
Provide the property description for the escrow payee. Canonical values are:
  • false
  • true
EscrwStat
The status of the escrow record.
EscrwTaxRefId
The tax reference ID for the property.
ForcedPlaceInsur
The forced place insurance.
InsurPlcyAmt
The amount of insurance for a specific policy.
InsurPlcyExpDt
The insurance policy's expiration date.
InsurPlcyId
The identification of the insurance policy.
InsurPlcyOrigDt
The insurance policy's origination date.
InsurPlcyPremium
The premium amount for the insurance.
InsurPlcyRenDt
The renewal date of the insurance policy.
InsurPlcyTermUnit
Term units:
  • Days
  • Indefinite
  • Months
  • Years

Canonical values are:

  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
OpenBal
The amount of funds used to establish an account.
PMICancelCode
The code that designates why the PMI insurance was canceled.
PMICancelDt
The date private mortgage insurance was canceled.
PMICancelNotCode
The code that designates the behavior of notices created when private mortgage insurance is canceled.
PMIExpDt
The date private mortgage insurance expires.
PMIHighRiskType
Is the escrow private mortgage insurance provided to a high risk loan? Canonical values are:
  • false
  • true
PMIHOEPANotCode
The code that represents the behavior for creating PMI notices under the HOEPA regulation.
PMILTVNotCode
The code that designates the behavior of notices created for private mortgage insurance at certain lone-to-value ratios.
PropLegalInfo
The legal description of the property.
PropParcelId
The parcel identification of the property.

EscrwPmtBalInfoRec_CType

EscrwPmtBalInfoRec_CType is a complex CType element.

Contains:

  • EscrwPmtBalArray_AType

Simple Elements

The following simple elements are contained within this complex.

EscrwCouponReOrder
Determines if a loan payment coupon book should be reordered. Canonical values are:
  • false
  • true
EscrwPaidPYTD
The escrow paid prior year-to-date.
EscrwPaidYTD
The escrow paid year-to-date.
EscrwPmtEffDt
The effective date of the new escrow payment amount.
EscrwShtPmtEffDt
The effective date after the shortage spread new payment amount.
EscrwYTDIntPaid
The amount of paid interest for a specific escrow record.
PMIPmtAmt
The PMI payment amount.
PMIPmtPart
The partial PMI payment amount.
PMIPmtPrevYTD
The year-to-date (YTD) previous PMI payments.
PMIPmtYTD
The year-to-date (YTD) PMI payments.
PMIPrepaidAmt
The prepaid PMI amount.

EscrwPmtBalArray_AType

EscrwPmtBalArray_AType is an array AType element. This is an array of escrow payments, balances, and related elements.

Contains:

  • EscrwPmtBalInfo_CType
EscrwPmtBalInfo_CType

EscrwPmtBalInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EscrwAccrInt
The unpaid interest for a specific escrow record.
EscrwCurBal
The current balance for a specific escrow record.
EscrwNewPmtAmt
The new payment amount for a specific escrow record.
EscrwNewShtPmtAmt
The new payment amount after the shortage spread for a specific escrow record.
EscrwPayoffExclBalType
The escrow payoff type that describes the business rules to exclude escrow balances in the payoff quote. Canonical values are:
  • false
  • NegOnly
  • true
EscrwPayoffExclIntType
The escrow payoff type that describes the business rules inclusion to exclude escrow interest in the payoff quote. Canonical values are:
  • false
  • NegOnly
  • true
EscrwPmtAmt
The amount of the escrow payment for a specific escrow recipient.
EscrwPmtBalDesc
The description that defines which payment and/or balance elements are exposed in the EscwPmtBalInfo complex array.
EscrwPrevYRBal
The previous year's current balance for a specific escrow record.
EscrwRateIdx
The rate index for a specific escrow balance.
EscrwRate
The rate for a specific escrow balance.

EscrwStateWith

StateWith_CType is a complex CType element. This element contains state tax withholding information. This element is optional.

EscrwStateWith references StateWith_CType.

Simple Elements

The following simple elements are contained within this complex.

StateWithAltAcctId
The state withholding alternate account number.
StateWithAltAcctType
The state withholding alternate account type D.
StateWithAltRate
The state withholding alternate rate.
StateWithCode
The state withholding code.
StateWithCycleAmt
The state withholding current cycle amount.
StateWithDesc
The state withholding code description.
StateWithEffDt
The state withholding effective date.
StateWithFixAmt
The state withholding fixed holding amount.
StateWithLastYR
The state withholding last year.
StateWithMTD
The state withholding month-to-date.
StateWithQTD
The state federal withholding quarter-to-date.
StateWithStateCode
The state withholding state code.
StateWithStateDesc
The state withholding state code.
StateWithYTD
The state withholding year-to-date.

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.

EscrwAddRs_MType

EscrwAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

EscrwId
The identification of the escrow record. For example, sequence number.
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 Mon Jan 24 2022