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

Bill Pay Electronic Bill Schedule Search

Enterprise SOAP API > API by Reference > Bill Pay Services > Bill Pay Electronic Bill Schedule Search

Bill Pay Electronic Bill Schedule Search

Bill Pay Electronic Bill Schedule Search is a jXchange service designed to provide a service to allow consumers to search through the Electronic Merchant schedule of bills.

Message Flow

In jXchange, the Bill Pay Electronic Bill Schedule Search Service service uses a typical exchange of MType messages to search through the Electronic Merchant schedule of bills.

Primary Request

The Third Party Consumer forwards the BilPayElecBilSchedSrchRq_MType message to the Service Provider. The message contains the following simple elements:

  • BilPayProd
  • ElecBilStat
  • PayeeName
  • PmtEndDt
  • PmtStartDt
  • SubId

Primary Response

The Service Provider returns the BilPayElecBilSchedSrchRs_MType message to the Third Party Consumer. The message contains the following simple elements:

  • BilPayProd
  • ElecBilStat
  • PayeeName
  • PmtEndDt
  • PmtStartDt
  • SubId

Bill Pay Electronic Bill Schedule Search Behavior

The BilPayElecBilSchedSrchRq_MType request message contains the StartDt, EndDt, PayeeName, and ElecBilStat elements. The service provider reserves the right to limit the response set by requiring a range of dates.

A consumer request with a StartDt element, and without an EndDt, returns all of the qualified Electronic Scheduled Bill records with a date equal to and greater than the PmtDueDt or StmtDt.

A consumer request with an EndDt, and without a StartDt, returns all of the Electronic Scheduled Bill records with a date equal to and less than the PmtDueDt or StmtDt.

A consumer request with a StartDt and an EndDt returns all of the Electronic Scheduled Bill records with a date equal to and greater than the PmtDueDt or StmtDt and a date equal to and less than the PmtDueDt or StmtDt.

The PayeeName element contains the SrchType attribute. The service provider must support the SrchType attribute's canonical values, which are ~Exact~, ~StartsWith~, and ~Contains~. The standard Wild Card Search tenets are applicable.

The BilPayElecBilSchedSrchRs_MType response message echoes the requested elements. The BilPayElecBilSchedSrchArray_AType array returns the elements related to an electronic merchant payee. The ElecBilId element can be cached by the consumer for subsequent messages.

The response is returned in last in, first out (LIFO) order.

BilPayElecBilSchedSrchRq_MType

BilPayElecBilSchedSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

BilPayProd
Used to show which product to use. Canonical values are:
  • BilPay - Bill Pay
  • Remit - Remittance

The default value is BilPay.

ElecBilPayeeAcctId
The numbers or characters that identify an account record.
ElecBilStat
The electronic bill status. Canonical values are:
  • ComingDue
  • Pd
  • SubProc
  • UnPd
PayeeName
The name of the payee.
PmtEndDt
The date that designates the ending point for date selections.
PmtStartDt
The date that designates the starting point for date selections.
SubId
The ID of the subscriber or end user.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message 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.
Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MaxRec
The maximum number of records when multiple records are returned.

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.

BilPayElecBilSchedSrchRs_MType

BilPayElecBilSchedSrchRs_MType is a message MType element.

Contains:

  • BilPayElecBilSchedSrchArray_AType
  • Custom_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ElecBilPayeeAcctId
The numbers or characters that identify an account record.
BilPayProd
Used to show which product to use. Canonical values are:
  • BilPay - Bill Pay
  • Remit - Remittance

The default value is BilPay.

ElecBilStat
The electronic bill status. Canonical values are:
  • ComingDue
  • Pd
  • SubProc
  • UnPd
PayeeName
The name of the payee.
PmtEndDt
The date that designates the ending point for date selections.
PmtStartDt
The date that designates the starting point for date selections.
SubId
The ID of the subscriber or end user.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MoreRec
Indicates if there are more records that could be returned. Canonical values are:
  • false
  • true
SentRec
The number of records sent in the response.
TotRec
Indicates the total records the request selected, which could be larger than MaxRec.

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.

BilPayElecBilSchedSrchArray_AType

BilPayElecBilSchedSrchArray_AType is an array AType element. This is an array of responses for an electronic bill schedule search.

Contains:

  • BilPayElecBilSchedSrchInfo_CType

BilPayElecBilSchedSrchInfo_CType

BilPayElecBilSchedSrchInfo_CType is a complex CType element. This is a package of data related to an electronic bill schedule search.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

CurBal
The current balance.
ElecBilId
An identification given to an electronic bill.
ElecBilPayeeAcctId
The numbers or characters that identify an account record.
ElecBilPayeeName
The name of the payee.
ElecBilStat
The electronic bill status. Canonical values are:
  • ComingDue
  • Pd
  • SubProc
  • UnPd
MinPmtAmt
The minimum payment amount.
PmtAmtDue
The payment amount due.
PmtDueDt
The date established for a scheduled payment.
StmtBal
The statement balance.
StmtDt
Statement Date.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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 Fri Jan 7 2022