Developer Resources
Details
SoapAction | http://jackhenry.com/ws/LnPmtSchedAdd |
Input Name | LnPmtSchedAdd |
Output Name | LnPmtSchedAddResponse |
Input Namespace | http://jackhenry.com/jxchange/TPG/2008 |
Group Name | Loan |
Container | TPG_LoanMaster.xsd |
XML Examples
LnPmtSchedAdd Skip Payment Request
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
<wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2021-03-16T20:34:39Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<LnPmtSchedAdd xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<Ver_1/>
<jXLogTrackingId>122222222</jXLogTrackingId>
<Ver_2/>
<InstRtId>011001276</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3>
</Ver_3>
<BusCorrelId>815D5410-32F8-48E4-8A0B-F6A0A25E609A</BusCorrelId>
<Ver_4>
</Ver_4>
<Ver_5>
</Ver_5>
<ValidConsmName></ValidConsmName>
<ValidConsmProd></ValidConsmProd>
<Ver_6/>
</jXchangeHdr>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<AccountId>
<AcctId>777888111</AcctId>
<AcctType>L</AcctType>
</AccountId>
<LnPmtSchedArray>
<LnPmtSchedInfo>
<PmtTerm>1</PmtTerm>
<PmtTermUnits>Months</PmtTermUnits>
<PmtSchedNum>5</PmtSchedNum>
<PIAmt>250.00</PIAmt>
<PmtAmt>250.00</PmtAmt>
<PmtStartDt>2021-01-20</PmtStartDt>
<PmtEndDt>2021-05-20</PmtEndDt>
<SuspPmtSchedCode>N</SuspPmtSchedCode>
</LnPmtSchedInfo>
<LnPmtSchedInfo>
<PmtSchedNum>2</PmtSchedNum>
<PIAmt>0</PIAmt>
<PmtAmt>0</PmtAmt>
<PmtStartDt>2021-06-20</PmtStartDt>
<PmtEndDt>2021-07-20</PmtEndDt>
<RepPmtSchedTerm>
<TermCnt>12</TermCnt>
<TermUnits>Months</TermUnits>
</RepPmtSchedTerm>
<SuspPmtSchedCode>Y</SuspPmtSchedCode>
<RepPmtSchedNum>1</RepPmtSchedNum>
</LnPmtSchedInfo>
<LnPmtSchedInfo>
<PmtSchedNum>10</PmtSchedNum>
<PIAmt>250.00</PIAmt>
<PmtAmt>250.00</PmtAmt>
<PmtStartDt>2021-08-20</PmtStartDt>
<PmtEndDt>2022-05-20</PmtEndDt>
<RepPmtSchedTerm>
<TermCnt>12</TermCnt>
<TermUnits>Months</TermUnits>
</RepPmtSchedTerm>
<SuspPmtSchedCode>N</SuspPmtSchedCode>
<RepPmtSchedNum>1</RepPmtSchedNum>
</LnPmtSchedInfo>
</LnPmtSchedArray>
<Custom/>
<Ver_1/>
</LnPmtSchedAdd>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML Request
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>{Insert}</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
<wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2018-11-27T15:09:22Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<LnPmtSchedAdd xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer/>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId/>
<ConsumerName/>
<ConsumerProd/>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>011001276</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId/>
<Ver_4/>
<WorkflowCorrelId/>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
<Ver_6/>
</jXchangeHdr>
</MsgRqHdr>
<ErrOvrRdInfoArray/>
<AccountId>
<AcctId>11755</AcctId>
<AcctType>L</AcctType>
<Ver_1/>
</AccountId>
<LnPmtSchedArray>
<LnPmtSchedInfo>
<PmtTerm>1</PmtTerm>
<PmtTermUnits>Months</PmtTermUnits>
<SemiDay1>0</SemiDay1>
<SemiDay2>0</SemiDay2>
<PmtSchedNum>1</PmtSchedNum>
<PmtCode/>
<PIAmt>0.0</PIAmt>
<PmtAmt>0.0</PmtAmt>
<EscrwPmtAmt>0.0</EscrwPmtAmt>
<PmtStartDt>2021-04-01</PmtStartDt>
<PmtEndDt>2021-04-30</PmtEndDt>
<SuspPmtSchedCode/>
<Ver_1/>
<NumPmtsPaid>0</NumPmtsPaid>
</LnPmtSchedInfo>
</LnPmtSchedArray>
<Custom/>
<Ver_1/>
</LnPmtSchedAdd>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
LnPmtSchedAdd FAQ
Question: For a skip payment that occurs once per year, would the <TermCnt>
be ‘12’ and <TermUnits>
be ‘Months’ since the payments are skipped on a yearly basis?
Answer: Yes, see the XML Skip example.
Question: SilverLake In the API documentation the field “RepPmtSchedNum” is defined as the number of times a specific payment schedule should be repeated, but, when we pass the numeric value to this field we getting an error saying “Element value must be Y or N”.Can you define the purpose of this field, if it is what is mentioned in the documentation, how its value can be ‘Y’ or ‘N’?
Answer: The documentation is incorrect and the element name is misleading. <RepPmtSchedNum>
maps to LNSCHD/SREP which is a boolean that indicates whether or not the particular LnPmtSchedInfo will repeat or not. It will accept “Y” or “1” for Repeat, and “N” or “0” for Do Not Repeat.
The PmtSchedNum element is what actually controls the number of times to repeat the schedule, so in the example given the second LnPmtSchedInfo says to skip payment (SuspPmtSchedCode = Y) for two months out of the year (PmtSchedNum = 2) and then make 10 payments of $250.00 for remainder of the year (SuspPmtSchedCode = N and PmtSchedPmt = 10). Unless you set RepPmtSchedNum to either “Y” or “1” the schedule will not repeat when the scheduled term ends at the end of the 12 months.