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 Payment Extension

Enterprise SOAP API > API by Reference > Core Services > Loan Payment Extension

Loan Payment Extension

Loan Payment Extension is a jXchange messaging service designed to extend a loan beyond the contractual maturity date.

Message Flow

Message flow involves the exchange of MType complexes between the Third Party Consumer and the Service Provider.

Primary Request

The Third Party Consumer forwards the LnPmtExtRq_MType complex to the Service Provider containing:

  • ErrOvrRdInfoArray_AType
  • AccountId_CType
  • LnPmtExtInfo_CType

Primary Response

The Service Provider returns the LnPmtExtRs_MType message containing:

  • CondNotfArray_AType
  • RsStat_Type

Behavior

The account identification is required.

The loan payment extension information complex contains the elements specific to the loan extension service, such as loan fees contained by an array. This is a required complex.

The response includes the condition notification array to convey to the consumer the other services that might need to be requested to complete the loan extension.

The Service Provider could return a fault if an extension already exists for the loan that would require the consumer to return the message with an override. The Service Provider will then overwrite the pervious extension.

Loan Payment Extension Business Case

In this example, a consumer is extending a loan.

The consumer sends the LnPmtExtRq message to the Service Provider with the following values:

Complex ElementSimple ElementEntry Value
AccountIdAcctId5551234555123456
AcctTypeL
Complex ElementSimple ElementEntry Value
LnPmtExtInfoNxtPayDt2010-04-27
PmtDayOfMonth27
MatDt2010-05-07
ExtTermTermCnt30
TermUnitsDays
DescAdd another month onto the loan.

The Service Provider returns the RsStat with a status of Success.

LnPmtExtRq_MType

LnPmtExtRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • LnPmtExtInfo_CType
  • MsgRqHdr_CType

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.

ErrCode
The Soap Header Fault error code.

LnPmtExtInfo_CType

LnPmtExtInfo_CType is a complex CType element.

Contains:

  • ExtTerm references Term_CType
  • LnFeeArray_AType

Simple Elements

The simple elements contained within this complex are listed below.

MatDt
The maturity date.
NxtPayDt
The next payment date.
PmtDayOfMonth
The day of month for payment. This code is only required if the payment due date is the 29th of the month.

ExtTerm

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

This element references the Term_CType.

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

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 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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.

LnPmtExtRs_MType

LnPmtExtRs_MType is a message MType element.

Contains:

  • CondNotfArray_AType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

CondNotfArray_AType

CondNotfArray_AType is an array AType element. This is an array of condition notifiers used to define conditional notification status.

Contains:

  • CondNotfInfo_CType

CondNotfInfo_CType

CondNotfInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CondNotf
The conditions that exist on an account or customer to notify the consumer to use another service. Canonical values:
  • AcctAnlys
  • AcctCombStmt
  • AcctProdOvrrd
  • AcctSweep
  • AddrAcct
  • AddrIRSRpt
  • AddrNot
  • AddrOvrrd
  • AddrPmts
  • AddrSeasonal
  • AddrStmt
  • AlertMsg
  • CollatMsg
  • CollatTrack
  • ColMsg
  • Escrw
  • FASB91
  • FraudAlert
  • LnPmtSched
  • LnRateSched
  • LnUnit
  • LineOfCr
  • MemoPost
  • Msg
  • ODProt
  • PlnBenf
  • RealEstateProp
  • StopAlerts
  • StopHold
  • StopPay
  • Stops
  • StopSpecInstr
  • TimeDepRenOvrrd
  • XferACH
  • XferFut

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 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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.
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