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 Payoff Inquiry

Enterprise SOAP API > API by Reference > Core Services > Loan Payoff Inquiry

Loan Payoff Inquiry

Loan Payoff Inquiry is a jXchange service designed to provide consumers with the ability to retrieve a loan payoff quote.

Message Flow

In jXchange, the Loan Payoff Inquiry service uses a typical exchange of MType messages to provide consumers with the ability to retrieve a loan payoff quote.

Primary Request

The third-party consumer forwards the LnPayoffInqRq_MType message to the service provider.

The message contains the following simple element:

  • EffDt

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the LnPayoffInqRs_MType message to the third-party consumer.

The message contains the following simple elements:

  • AccrInt
  • BankDisc
  • CurBal
  • DailyAccrAmt
  • DlrDisc
  • DlrRebate
  • EffDt
  • EscrwAmt
  • EscrwIntWithAmt
  • FeeAmt
  • InsDailyAccrAmt
  • InsurAmt
  • IntRebate
  • LateChgDueAmt
  • MinInt
  • NetMemoPostAmt
  • OthChgAmt
  • PartPmtAmt
  • PayoffAmt
  • PayoffPend
  • PrePmtPenAmt
  • SecdAccr

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • MsgRsHdr_CType

The message contains the following arrays:

  • EscrwPayoffArray_AType
  • FeePayoffArray_AType
  • InsurPayoffArray_AType
  • MemoPostArray_AType

Loan Payoff Inquiry Behavior

The AccountId_CType complex is required on the request.

The LnPayoffInqRq_MType message request provides the consumer a means to submit an effective date, which may be a past or future date. The default date is the business date of message receipt.

The standard message header tenets are applicable. The elements in the request message are echoed back in the LnPayoffInqRs_MType response message.

The PayoffAmt element annotates the mathematical business rule for result value of the PayoffAmt element. The PayoffAmt element value must cross foot balance to the CurBal, AccrInt, SecdAccr, IntRebate, DlrRebate, LateChgDueAmt, OthChgAmt, PartPmtAmt, MinInt, PrePmtPenAmt, InsurAmt, EscrwAmt, and FeeAmt elements.

The signed value delivered by the Service Provider per element dictates the impact to the PayoffAmt element value. For example, any element that reduces the payoff amount value will be delivered as a negative integer.

The InsurAmt, EscrwAmt, and FeeAmt elements have a matching array that conveys to the consumer the details of the mentioned elements.

The InsurAmt element value must cross foot to the InsurRebate and/or InsurAccrAmt element value(s) whenever the ExclInsurAmtType element is ~false~. The default value is ~false~. The signed value tenet, mentioned above, applies to these values.

The EscrwAmt element value must cross foot to the EscrwBal and/or EscrwAccrInt element value(s) whenever the ExclEscrwAmtType element is ~false~. The default value is ~false~. The signed value tenet, mentioned above, applies to these values.

The FeeAmt element value must cross foot to the LnFeeAmt element value whenever the ExclFeeAmtType element is ~false~. The default value is ~false~. The signed value tenet, mentioned above, applies to these values.

The arrays mentioned above allow the Service Provider to convey all of the insurance, escrow, and/or fee components regardless of the impact to the current payoff by utilization of their respective Exclude and/or Amount Type element.

The NetMemoPostAmt is informational to the consumer and is not part of the inquiry response element values that cross foot to the PayoffAmt element.

The MemoPostArray_AType allows the service provider to convey the details of the NetMemoPostAmt element.

LnPayoffInqRq_MType

LnPayoffInqRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

EffDt
The date assigned to transactions when it is different from the posting date.

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.

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.

LnPayoffInqRs_MType

LnPayoffInqRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • EscrwPayoffArray_AType
  • FeePayoffArray_AType
  • InsurPayoffArray_AType
  • MemoPostArray_AType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

AccrInt
The accrued interest.
BankDisc
Bank discount is the amount of unearned interest on the loan. This field is only active on add-on type loans.
CurBal
The current balance.
DailyAccrAmt
The daily accrued amount.
DlrDisc
The amount of dealer discount.
DlrRebate
The dealer rebate.
EffDt
The date assigned to transactions when it is different from the posting date.
EscrwAmt
The amount of escrow balances related to a loan.
EscrwIntWithAmt
The amount of taxes being withheld from escrow interest.
FeeAmt
The amount of fees.
InsDailyAccrAmt
The amount of insurance daily accrual amount.
InsurAmt
The amount of insurance related to a loan.
IntRebate
The interest rebate.
LateChgDueAmt
The late charge due amount.
MinInt
The minimum interest.
NetMemoPostAmt
The sum of the current memo-posted items against this account.
OthChgAmt
Other charges.
PartPmtAmt
The partial payment amount.
PayoffAmt
The total loan payoff provided for loan payoff inquiry.

The loan payoff amount is the net amount of the elements with the following business mathematics [CurBal] + [AccrInt] + [SecdAccr] + [LateChgDueAmt] + [OthChgAmt] + [MinInt] + [PrePmtPenAmt] + [FeeAmt]) + [IntRebate] + [DlrRebate] + [InsurAmt] + [EscrwAmt] + [PartPmtAmt] + [EscrwIntWithAmt]

PayoffPend
Payoff pending canonical values are:
  • false
  • true
PrePmtPenAmt
The penalty amount for an early loan payoff.
SecdAccr
The secondary accrual.

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.

EscrwPayoffArray_AType

EscrwPayoffArray_AType is an array AType element. This is an array of elements for escrow net amount provided in the payoff.

Contains:

  • EscrwPayoffInfo_CType

EscrwPayoffInfo_CType

EscrwPayoffInfo_CType is a complex CType element.

Contains:

  • CustomEscrwPayoffRec references Custom_CType
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.
EscrwIntWithAmt
The amount of taxes being withheld from escrow interest.
EscrwTypeCode
The code that designates the type of escrow record. For example, insurance or taxes.
EscrwTypeDesc
The description of the code that designates the type of escrow record. For example, insurance or taxes.
ExclEscrwAmtType
Answers the question: Does this escrow value impact the loan payoff? Canonical values are:
  • false
  • true
ExclEscrwIntAmtType
Answers this question: Does this escrow interest value affect the loan payoff? Canonical values are:
  • false
  • true
CustomEscrwPayoffRec

Custom_CType is a complex CType element.

CustomEscrwPayoffRec references Custom_CType.

This element is optional.

FeePayoffArray_AType

FeePayoffArray_AType is an array AType element. This is an array of elements for fee net amount provided in the payoff.

Contains:

  • FeePayoffInfo_CType

FeePayoffInfo_CType

FeePayoffInfo_CType is a complex CType element.

Contains:

  • CustomFeePayoffRec references Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ExclFeeAmtType
Answers the question: Does this fee value impact the loan payoff? Canonical values are:
  • false
  • true
LnFeeAmt
The amount of specific loan fees collected.
LnFeeCode
The code that describes the details of charging a loan fee.
LnFeeDesc
The description of the code that describes the details of charging a loan fee.
CustomFeePayoffRec

Custom_CType is a complex CType element.

CustomFeePayoffRec references Custom_CType.

This element is optional.

InsurPayoffArray_AType

InsurPayoffArray_AType is an array AType element. This is an array of elements for insurance net amount provided in the payoff.

Contains:

  • InsurPayoffInfo_CType

InsurPayoffInfo_CType

InsurPayoffInfo_CType is a complex CType element.

Contains:

  • CustomInsurPayoffRec references Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ExclInsurAmtType
Answers the question: Does this insurance value impact the loan payoff? Canonical values are:
  • false
  • true
InsurAccrAmt
The amount of the insurance that has accrued for a loan.
InsurDesc
The description of the type of insurance.
InsurPlcyPremium
The premium amount for the insurance.
InsurRebate
The amount of the insurance premium that can be rebated.
InsurType
The type of insurance. Canonical values are:
  • AH
  • CrLife
  • Oth
  • PMI
CustomInsurPayoffRec

Custom_CType is a complex CType element.

CustomInsurPayoffRec references Custom_CType.

This element is optional.

MemoPostArray_AType

MemoPostArray_AType is an array AType element. This is an array of elements for memo post net amount.

Contains:

  • MemoPostInfo_CType

MemoPostInfo_CType

MemoPostInfo_CType is a complex CType element.

Contains:

  • CustomMemoPostRec references Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AffCode
The code that designates how the behavior influenced values of an account.
Amt
The amount or quantity.
PostDt
The date a transaction has posted or is scheduled to be posted to an account.
TrnType
The grouping of monetary transactions by a specific code.
CustomMemoPostRec

Custom_CType is a complex CType element.

CustomMemoPostRec references Custom_CType.

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