Developer Resources
Enterprise SOAP API
>
API by Reference
>
Bill Pay Services
>
Bill Pay Payee Add
>
Developer Resources
Details
SoapAction | http://jackhenry.com/ws/BilPayPayeeAdd |
Input Name | BilPayPayeeAdd |
Output Name | BilPayPayeeAddResponse |
Input Namespace | http://jackhenry.com/jxchange/TPG/2008 |
Group Name | BillPay |
Container | TPG_BillPayMaster.xsd |
XML Examples
BilPayPayeeAdd-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">2018-11-12T15:18:47Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<BilPayPayeeAdd 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>
<ErrOvrRd>
<ErrCode></ErrCode>
<Ver_1/>
</ErrOvrRd>
</ErrOvrRdInfoArray>
<BilPayProd>BilPay</BilPayProd>
<SubId>1468098094</SubId>
<BilPayPayeeInfo>
<PayeeName>Sarah Silverman</PayeeName>
<PayeeNickname></PayeeNickname>
<PayeeAddrInfoArray>
<PayeeAddrInfo>
<PayeeAddrId></PayeeAddrId>
<PayeeAddr>
<FreeFormAddrArray>
<AddrLineInfo>
<AddrLine>111 Silver St.</AddrLine>
<Ver_1/>
</AddrLineInfo>
</FreeFormAddrArray>
<StreetAddr1>111 Silver St.</StreetAddr1>
<StreetAddr2></StreetAddr2>
<City></City>
<StateProv></StateProv>
<StateCode>CA</StateCode>
<PostalCode>55555</PostalCode>
<DlvryPt></DlvryPt>
<County></County>
<Cntry></Cntry>
<CntryType></CntryType>
<BusAddr></BusAddr>
<FornAddr></FornAddr>
<InvAddr></InvAddr>
<Ver_1/>
<StreetAddr3></StreetAddr3>
<Ver_2/>
</PayeeAddr>
<PayeeAddrType>Prim</PayeeAddrType>
<Custom></Custom>
<Ver_1/>
</PayeeAddrInfo>
</PayeeAddrInfoArray>
<PayeePhoneArray>
<PhoneInfo>
<PhoneNum>2305555555</PhoneNum>
<PhoneType>home</PhoneType>
<PhoneTime>day</PhoneTime>
<PhoneExt></PhoneExt>
<Ver_1/>
<ConStartTime>10:00:00.689Z</ConStartTime>
<ConEndTime>15:00:00.689Z</ConEndTime>
<MobPhoneInfo>
<MobPrvdCode></MobPrvdCode>
<MobPrvdCodeDesc></MobPrvdCodeDesc>
<MobPrvdDom></MobPrvdDom>
<MobBB></MobBB>
<MobSendTestText></MobSendTestText>
<Ver_1/>
</MobPhoneInfo>
<Ver_2/>
<PrioritySeq>0</PrioritySeq>
<Ver_3/>
<PhoneNumDsp>(XXX)XXX-XXXX</PhoneNumDsp>
<Ver_4/>
</PhoneInfo>
</PayeePhoneArray>
<PayeeEmailArray>
<EmailInfo>
<EmailAddr>sarah@silver.com</EmailAddr>
<EmailType>Home</EmailType>
<Ver_1/>
</EmailInfo>
</PayeeEmailArray>
<PayeeEmailSharedSecret></PayeeEmailSharedSecret>
<PayeeClsf>Indv</PayeeClsf>
<PayeeFIAcctInfo>
<FIRtId>123456789</FIRtId>
<FIAcctId>112235465</FIAcctId>
<FIAcctType></FIAcctType>
<Custom></Custom>
<Ver_1/>
</PayeeFIAcctInfo>
<SubMerAcctId>1234567890</SubMerAcctId>
<SubMerPayerName>Sarah S.</SubMerPayerName>
<PayeeCatName></PayeeCatName>
<PayFromAcctInfo>
<PayFromId>1234567899</PayFromId>
<PayFromAcctId></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>
<Ver_1/>
</PayFromAcctOwnName>
<PayFromAcctOwnAddr>
<FreeFormAddrArray>
<AddrLineInfo>
<AddrLine></AddrLine>
<Ver_1/>
</AddrLineInfo>
<AddrLineInfo>
<AddrLine></AddrLine>
<Ver_1/>
</AddrLineInfo>
</FreeFormAddrArray>
<StreetAddr1></StreetAddr1>
<StreetAddr2></StreetAddr2>
<City></City>
<StateProv></StateProv>
<StateCode></StateCode>
<PostalCode></PostalCode>
<DlvryPt></DlvryPt>
<County></County>
<Cntry></Cntry>
<CntryType></CntryType>
<BusAddr></BusAddr>
<FornAddr></FornAddr>
<InvAddr></InvAddr>
<Ver_1/>
<StreetAddr3></StreetAddr3>
<Ver_2/>
</PayFromAcctOwnAddr>
<Ver_4/>
</PayFromAcctInfo>
<Custom></Custom>
<Ver_1/>
<BilPaySvcFeeArray>
<BilPaySvcFeeInfoRec>
<SvcFeeCode></SvcFeeCode>
<SvcFeeDesc></SvcFeeDesc>
<SvcFeeAmt>0.0</SvcFeeAmt>
<Custom></Custom>
<Ver_1/>
</BilPaySvcFeeInfoRec>
</BilPaySvcFeeArray>
<Ver_2/>
<ElecBilPayeeType>Alw</ElecBilPayeeType>
<ElecBilAcctErrExist>false</ElecBilAcctErrExist>
<Ver_3/>
<PmtIntentType>PayBill</PmtIntentType>
<Ver_4/>
<PayeeP2PType>SMS</PayeeP2PType>
<Ver_5/>
<LastMainDt>2018-11-01</LastMainDt>
<Ver_6/>
<ElecBilPayeeCatType>Det</ElecBilPayeeCatType>
<Ver_7/>
</BilPayPayeeInfo>
<Custom></Custom>
<Ver_1/>
</BilPayPayeeAdd>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
FAQ
BilPayPayeeAddFAQ
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