Developer Resources
Enterprise SOAP API
>
API by Reference
>
Bill Pay Services
>
Bill Pay Scheduled Payment Add
>
Developer Resources
Details
SoapAction | http://jackhenry.com/ws/BilPaySchedPmtAdd |
Input Name | BilPaySchedPmtAdd |
Output Name | BilPaySchedPmtAddResponse |
Input Namespace | http://jackhenry.com/jxchange/TPG/2008 |
Group Name | BillPay |
Container | TPG_BillPayMaster.xsd |
XML Examples
BilPaySchedPmtAdd-XML
<?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">2019-01-03T20:34:09Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<BilPaySchedPmtAdd xmlns="http://jackhenry.com/jxchange/TPG/2008">
<MsgRqHdr>
<jXchangeHdr>
<JxVer></JxVer>
<AuditUsrId></AuditUsrId>
<AuditWsId></AuditWsId>
<AuthenUsrId></AuthenUsrId>
<ConsumerName></ConsumerName>
<ConsumerProd></ConsumerProd>
<Ver_1/>
<jXLogTrackingId>{Insert}</jXLogTrackingId>
<Ver_2/>
<InstRtId>011002343</InstRtId>
<InstEnv>TEST</InstEnv>
<Ver_3/>
<BusCorrelId></BusCorrelId>
<Ver_4/>
<WorkflowCorrelId></WorkflowCorrelId>
<Ver_5/>
<ValidConsmName>{Insert}</ValidConsmName>
<ValidConsmProd>{Insert}</ValidConsmProd>
<Ver_6/>
</jXchangeHdr>
<Ver_1/>
<Ver_2/>
<Ver_3/>
</MsgRqHdr>
<ErrOvrRdInfoArray>
<ErrOvrRd>
<ErrCode></ErrCode>
<Ver_1/>
</ErrOvrRd>
</ErrOvrRdInfoArray>
<BilPayProd>BilPay</BilPayProd>
<SubId>1468098094</SubId>
<BilPaySchedPmtInfo>
<PmtPayeeInfo>
<PayeeId>2</PayeeId>
<PayeeName></PayeeName>
<PayeeNickname></PayeeNickname>
<PayeeAddrInfo>
<PayeeAddrId></PayeeAddrId>
<PayeeAddr>
<FreeFormAddrArray>
<AddrLineInfo>
<AddrLine></AddrLine>
<Ver_1/>
</AddrLineInfo>
</FreeFormAddrArray>
<StreetAddr1></StreetAddr1>
<StreetAddr2></StreetAddr2>
<City></City>
<StateProv></StateProv>
<StateCode MaskVal=""></StateCode>
<PostalCode MaskVal=""></PostalCode>
<DlvryPt></DlvryPt>
<County></County>
<Cntry MaskVal=""></Cntry>
<CntryType MaskVal=""></CntryType>
<BusAddr></BusAddr>
<FornAddr></FornAddr>
<InvAddr></InvAddr>
<Ver_1/>
<StreetAddr3></StreetAddr3>
<Ver_2/>
</PayeeAddr>
<PayeeAddrType></PayeeAddrType>
<Custom></Custom>
<Ver_1/>
</PayeeAddrInfo>
<PayeePhoneArray>
<PhoneInfo>
<PhoneNum SrchType=""></PhoneNum>
<PhoneType></PhoneType>
<PhoneTime></PhoneTime>
<PhoneExt></PhoneExt>
<Ver_1/>
<ConStartTime>20:32:32.096Z</ConStartTime>
<ConEndTime>20:32:32.096Z</ConEndTime>
<MobPhoneInfo>
<MobPrvdCode></MobPrvdCode>
<MobPrvdCodeDesc></MobPrvdCodeDesc>
<MobPrvdDom></MobPrvdDom>
<MobBB></MobBB>
<MobSendTestText></MobSendTestText>
<Ver_1/>
</MobPhoneInfo>
<Ver_2/>
<PrioritySeq>0</PrioritySeq>
<Ver_3/>
<PhoneNumDsp></PhoneNumDsp>
<Ver_4/>
</PhoneInfo>
</PayeePhoneArray>
<PayeeEmailArray>
<EmailInfo>
<EmailAddr NotOccurType=""></EmailAddr>
<EmailType></EmailType>
<Ver_1/>
</EmailInfo>
</PayeeEmailArray>
<PayeeClsf></PayeeClsf>
<PayeePmtMthd></PayeePmtMthd>
<SubMerAcctId></SubMerAcctId>
<SubMerPayerName></SubMerPayerName>
<PayeeCatName></PayeeCatName>
<Custom></Custom>
<Ver_1/>
<PmtIntentType></PmtIntentType>
<Ver_2/>
</PmtPayeeInfo>
<PmtRushOptInfo>
<RushOpt></RushOpt>
<RushOptFeeAmt>0.0</RushOptFeeAmt>
<RushOptSurChg>0.0</RushOptSurChg>
<Custom></Custom>
<Ver_1/>
</PmtRushOptInfo>
<PmtProcDt>2021-01-04</PmtProcDt>
<PmtEstArvDt>2021-01-04</PmtEstArvDt>
<PmtAmt>20.0</PmtAmt>
<PmtPayFromAcctInfo>
<PayFromId></PayFromId>
<PayFromAcctId MaskVal="">22</PayFromAcctId>
<PayFromAcctType></PayFromAcctType>
<PayFromAcctName></PayFromAcctName>
<PayFromAcctDft></PayFromAcctDft>
<Custom></Custom>
<Ver_1/>
<StartChkNum></StartChkNum>
<Ver_2/>
<PayFromInstRtId>011002343</PayFromInstRtId>
<PayFromAcctStat></PayFromAcctStat>
<Ver_3/>
<PayFromAcctOwnName>
<ComName></ComName>
<FirstName></FirstName>
<MiddleName></MiddleName>
<LastName></LastName>
<x_PersonName>
<TitlePrefix></TitlePrefix>
<NameSuffix></NameSuffix>
<LegalName></LegalName>
<SalName></SalName>
<Ver_1/>
<AbbName></AbbName>
<Ver_2/>
</x_PersonName>
<Ver_1/>
</PayFromAcctOwnName>
<PayFromAcctOwnAddr>
<FreeFormAddrArray>
<AddrLineInfo>
<AddrLine></AddrLine>
<Ver_1/>
</AddrLineInfo>
</FreeFormAddrArray>
<StreetAddr1></StreetAddr1>
<StreetAddr2></StreetAddr2>
<City></City>
<StateProv></StateProv>
<StateCode MaskVal=""></StateCode>
<PostalCode MaskVal=""></PostalCode>
<DlvryPt></DlvryPt>
<County></County>
<Cntry MaskVal=""></Cntry>
<CntryType MaskVal=""></CntryType>
<BusAddr></BusAddr>
<FornAddr></FornAddr>
<InvAddr></InvAddr>
<Ver_1/>
<StreetAddr3></StreetAddr3>
<Ver_2/>
</PayFromAcctOwnAddr>
<Ver_4/>
</PmtPayFromAcctInfo>
<PmtCmnt></PmtCmnt>
<PmtChkMemo></PmtChkMemo>
<Custom></Custom>
<Ver_1/>
<RecurPmtInfo>
<StartPmtProcDt>2021-01-04</StartPmtProcDt>
<StartPmtEstArvDt>2021-01-04</StartPmtEstArvDt>
<PmtFreqUnits>Weekly</PmtFreqUnits>
<PmtDayOfWeek>Mon</PmtDayOfWeek>
<!-- <PmtDayInfoArray>
<PmtDayInfo>
<PmtDayOfMonth>0</PmtDayOfMonth>
<PmtUseLastBusDay></PmtUseLastBusDay>
<Custom></Custom>
<Ver_1/>
</PmtDayInfo>
</PmtDayInfoArray> -->
<PayDtInstr>Before</PayDtInstr>
<PmtOccur>2</PmtOccur>
<PmtSerExpDt>2021-01-18</PmtSerExpDt>
<PmtSerFinite></PmtSerFinite>
<PmtFinalAmt>20.00</PmtFinalAmt>
<Custom></Custom>
<Ver_1/>
<RetroToOrigPmtDt></RetroToOrigPmtDt>
<Ver_2/>
</RecurPmtInfo>
<Ver_2/>
<!-- <InvoiceInfoArray>
<InvoiceInfo>
<InvoiceId></InvoiceId>
<InvoiceNum></InvoiceNum>
<InvoiceCat></InvoiceCat>
<InvoiceDesc></InvoiceDesc>
<InvoiceAmtPos>0.0</InvoiceAmtPos>
<InvoiceAmtNeg>0.0</InvoiceAmtNeg>
<Custom></Custom>
<Ver_1/>
</InvoiceInfo>
</InvoiceInfoArray> -->
<Ver_3/>
<BilPaySvcFeeInfoRec>
<SvcFeeCode></SvcFeeCode>
<SvcFeeDesc></SvcFeeDesc>
<SvcFeeAmt>0.0</SvcFeeAmt>
<Custom></Custom>
<Ver_1/>
</BilPaySvcFeeInfoRec>
<Ver_4/>
<SubCmntToPayee></SubCmntToPayee>
<Ver_5/>
<PmtIntentType></PmtIntentType>
<Ver_6/>
</BilPaySchedPmtInfo>
<Custom></Custom>
<Ver_1/>
</BilPaySchedPmtAdd>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
FAQ
BilPaySchedPmtAddFAQ
Coming Soon.
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 Mar 6 2024