Bill Pay Payee Search
Bill Pay Payee Search
Bill Pay Payee Search is a jXchange service designed to retrieve a list of payees for a subscriber.
Message Flow
In jXchange, the Bill Pay Payee
Search service uses a typical exchange of MType messages
to return a list of all payees for a particular bill pay product and
subscriber.
Primary Request
The Third Party Consumer
forwards the BilPayPayeeSrchRq_MType message to the
Service Provider. The message contains three filters:
ExclNonAct- The default is false.IncDlt- The default is false.PayeeCatName
It also contains BilPayProd and
SubId simple elements.
Primary Response
The Service Provider returns
the BilPayPayeeSrchRs_MType message to the Third Party
Consumer. The message contains an echo of the request, even if those same
elements exist in the repeating complex.
Bill Pay Payee Search Behavior
The bill pay payee search returns all payees for a particular bill pay product and subscriber.
The request provides the following filters:
- Payee Category name (PayeeCatName)
- Exclude Non-Activated (ExclNonAct) - The default is false.
- Include Deleted (IncDlt) - The default is false.
When there is more than one filter on the request, then the selection is based on ~and~ rather ~or~.
The standard search message header tenets are applicable.
The elements on the request message are echoed on the response, regardless if those same elements exist in the repeating complex.
The Electronic Merchant Payee Only (ElecMerPayeeOnly) simple element was added as a filter to the search request message. The added filter is part of an ~And~ relationship to other filters at the request. The default value for the ElecMerPayeeOnly simple element should be the value that allows the service provider to maintain backwards compatibility.
The ElecMerPayeeOnly simple element was added as an echo back in the search response.
BilPayPayeeSrchRq_MType
BilPayPayeeSrchRq_MType is a message
MType element.
Contains:
Custom_CTypeSrchMsgRqHdr_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.
- CardPayFilter
- The filter for searching card-funded payees which should be returned
in the response. Canonical values are:
- Incl
- OnlyCardPay
- Excl
The default value is Incl.
- ElecMerPayeeOnly
- Answers the question: Should only electronic merchant's payees be
included? Canonical values are:
- false
- true
- ExclNonAct
- Used to exclude non-activated. Canonical values are:
- false
- true
- IncDlt
- Used to include deleted. Canonical values are:
- false
- true
- LastMainEndDt
- The date that designates the ending point for date selections.
- LastMainStartDt
- The date that designates the starting point for date selections.
- PayeeCatName
- The category name assigned to a payee.
- 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_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 canonical value is JHA.
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
- 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
BilPayPayeeSrchRs_MType
BilPayPayeeSrchRs_MType is a message
MType element.
Contains:
BilPayPayeeSrchArray_ATypeCustom_CTypeSrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CardPayFilter
- The filter for searching card-funded payees which should be returned
in the response. Canonical values are:
- Incl
- OnlyCardPay
- Excl
The default value is Incl.
- ElecMerPayeeOnly
- Answers the question: Should only electronic merchant's payees be
included? Canonical values are:
- false
- true
- ExclNonAct
- Used to exclude non-activated. Canonical values are:
- false
- true
- IncDlt
- Used to include deleted. Canonical values are:
- false
- true
- LastMainEndDt
- The date that designates the ending point for date selections.
- LastMainStartDt
- The date that designates the starting point for date selections.
- PayeeCatName
- The category name assigned to a payee.
- SubId
- The ID of the subscriber or end user.
BilPayPayeeSrchArray_AType
BilPayPayeeSrchArray_AType is an array
AType element. This is an array of responses from a payee
search.
Contains:
BilPayPayeeSrchInfo_CType
BilPayPayeeSrchInfo_CType
BilPayPayeeSrchInfo_CType is a complex CType element. This is a package of
data related to a bill pay payee search.
Contains:
Custom_CTypePayFromAcctInfo_CTypeRushOptArray_AType
Simple Elements
The following simple elements are contained within this complex.
- CanRush
- Used to show if the merchant offers rush options. Canonical values
are:
- false
- true
- ElecBilAcctErrExist
- Answers the question: Does the payee have any outstanding account
errors related to electronic merchant billing? Canonical values are:
- false
- true
- ElecBillPayeeCatType
- The electronic bill payee category. Canonical values are:
- Det
- Sum
- ElecBilPayeeType
- The type of electronic billing payee type. Canonical values are:
- Alw
- Enroll
- EnrollAlw
- EnrollPend
- NotAlw
- EstArvDay
- The number of days from the processing date for calculating the estimated arrival date.
- FirstAvlEstArvDt
- The first date a payment can be made for financial institutions using the good-funds payment model.
- FirstAvlProcDt
- The first date a payment can be processed for financial institutions using the process-date payment model.
- LastMainDt
- The last maintenance date.
- PayeeCatName
- The category name assigned to a payee.
- PayeeClsf
- The classification of a payee. Canonical values are:
- Comp
- FinInst
- Indv
- PayeeId
- The payee identifier.
- PayeeLastPdAmt
- Amount last paid to the payee by subscriber.
- PayeeLastPdDt
- The last time the payee was paid by the subscriber.
- PayeeName
- The name of the payee.
- PayeeNickname
- The nickname given to a payee.
- PayeePmtMthd
- Payment method. Canonical values are:
- Chk - check
- Elec - electronic
- Email - electronic but set up via an email process
- PayeeStat
- Used to show the state of the payee. Canonical values are:
- Act - activated
- Dlt - deleted
- NotAct - not activated
- PmtIntentType
- The payment intention type. Canonical values are:
- PayBill - payment for a bill
- XferToSubFinInst - transfer to the subscriber's financial institution (outbound)
- XferFromSubFinInst - transfer from the subscriber's financial institution (inbound)
- XferTo - internal transfer to subscriber's account
- XferFrom - internal transfer from subscriber's account
The default value is PayBill.
- SubMerAcctId
- The subscriber's account identifier at the merchant.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PayFromAcctInfo_CType
PayFromAcctInfo_CType is a complex
CType element. This is a
package of data related to a pay from account.
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- PayFromAcctDft
- Designated as the default pay from account. Canonical values are:
- false
- true
- PayFromAcctId
- The number or character that identifies an account record.
- PayFromAcctName
- The account name for the subscriber's pay from account.
- PayFromAcctType
- The number or character that categorizes the AcctId.
- PayFromId
- The identifier for the Pay From account.
- StartChkNum
- The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RushOptArray_AType
RushOptArray_AType is an array
AType element. This is an array of payee valid rush
options.
Contains:
RushOptreferencesRushOptInfo_CType
RushOpt
RushOptInfo_CType is a complex
CType element. This is a
package of data related to a rush option.
RushOpt references
RushOptInfo_CType.
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- RushOptFeeAmt
- The fee associated with the rush option.
- RushOpt
- Option for rushing a payment to a payee. Canonical values are:
- 2ndDay - second day
- 2ndDayEc - second day economy
- Ovrngt - overnight
- Std - standard
- RushOptSurChg
- The surcharge associated with the rush option.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 canonical value is JHA.
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
- 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
MsgRecInfoArray_AType
MsgRecInfoArray_AType is an array
AType element. This is an array of messages that can be
returned in a response.
Contains:
MsgRec_CType
MsgRec_CType
MsgRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ErrCat
- The Soap Header Fault error category.
- ErrCode
- The Soap Header Fault error code.
- ErrDesc
- The Soap Header Fault error description.
- ErrElem
- The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
- ErrElemVal
- The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
- ErrLoc
- The Soap Header Fault error location. This is typically the program that generated the error condition.