Bill Pay Scheduled Payment Search
Bill Pay Scheduled Payment Search
Bill Pay Scheduled Payment Search is a jXchange service designed to search for scheduled payments.
Message Flow
In jXchange, the Bill Pay Scheduled
Payment Search service uses a typical exchange of MType messages to search
scheduled payments for bill pay payees.
Primary Request
The Third Party Consumer forwards the
BilPaySchedPmtSrchRq_MType
message to the Service Provider. The message contains six filters:
PayeeIdPmtHighAmtPmtLowAmtPmtProcEndDtPmtProcStartDtPmtStat- The default is All
It also contains the BilPayProd,
PayeeId, and SubId simple
elements.
Primary Response
The Service Provider returns the
BilPaySchedPmtSrchRs_MType
message to the Third Party Consumer. The message contains an echo of those
elements in the request, even if those same elements exist in the
repeating complex.
Bill Pay Scheduled Payment Search Behavior
The response returns all scheduled payments for a particular bill pay product and subscriber.
The request provides the following filters on the request:
- Payment processing start date
<
PmtProcStartDt> - Payment processing end date
<
PmtProcEndDt> - Payment low amount <
PmtLowAmt> - Payment high amount <
PmtHighAmt> - Payment status <
PmtStat> - The default is All - Payee Id - <
PayeeId>
When there is more than one filter on the request, the selection is based on ~and~ rather than ~or~.
The standard search message header tenets are applicable.
The elements on the request are echoed back at the response, regardless if those same elements exist in the repeating complex.
BilPaySchedPmtSrchRq_MType
BilPaySchedPmtSrchRq_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 that should be returned in the response. Canonical values are:
- Incl
- OnlyCardPay
- Excl
The default value is Incl.
- P2PFilter
- Filter for searching for P2P. Canonical values are:
- Excl
- Incl
- OnlyP2P
- PayeeId
- The payee identifier.
- PayeePmtMthd
- Payment method. Canonical values are:
- Chk - check
- Elec - electronic
- Email - electronic but set up via an email process
- PmtEndDt
- The date that designates the ending point for date selections.
- PmtHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- 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.
- PmtLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- PmtStartDt
- The date that designates the starting point for date selections.
- PmtStat
- The status of a payment. Canonical values are:
- All - all
- Canc - canceled
- Pd - paid
- Pend - pend
- PendSkip - pending skip
- Proc - processed
- Ret - returned
- Rfd - refunded
- Sched - scheduled
- Skip - skipped
- Stop - stopped
- Sttl - settled
- RecurFilter
- Determines which filter should be used to search for recurring
payments. Canonical values are:
- Excl - Exclude recurring
- Inc - Include recurring
- OnlyRecur - Only show recurring
- SubId
- The ID of the subscriber or end user.
- XferFilter
- The transfer filter. Canonical values are:
- Incl - Response includes transfers.
- OnlyXfer - Response only returns transfers.
- Excl - Response does not return any transfers.
The default value is Incl.
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.
BilPaySchedPmtSrchRs_MType
BilPaySchedPmtSrchRs_MType is a message
MType element.
Contains:
BilPaySchedPmtSrchArray_ATypeCustom_CTypeSrchMsgRsHdr_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 that should be returned in the response. Canonical values are:
- Incl
- OnlyCardPay
- Excl
The default value is Incl.
- P2PFilter
- Filter for searching for P2P. Canonical values are:
- Excl
- Incl
- OnlyP2P
- PayeeId
- The payee identifier.
- PayeePmtMthd
- Payment method. Canonical values are:
- Chk - check
- Elec - electronic
- Email - electronic but set up via an email process
- PmtEndDt
- The date that designates the ending point for date selections.
- PmtHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- 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.
- PmtLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- PmtStartDt
- The date that designates the starting point for date selections.
- PmtStat
- The status of a payment. Canonical values are:
- All - all
- Canc - canceled
- Pd - paid
- Pend - pend
- PendSkip - pending skip
- Proc - processed
- Ret - returned
- Rfd - refunded
- Sched - scheduled
- Skip - skipped
- Stop - stopped
- Sttl - settled
- RecurFilter
- Determines which filter should be used to search for recurring
payments. Canonical values are:
- Excl - Exclude recurring
- Inc - Include recurring
- OnlyRecur - Only show recurring
- SubId
- The ID of the subscriber or end user.
- XferFilter
- The transfer filter. Canonical values are:
- Incl - Response includes transfers.
- OnlyXfer - Response only returns transfers.
- Excl - Response does not return any transfers.
The default value is Incl.
BilPaySchedPmtSrchArray_AType
BilPaySchedPmtSrchArray_AType is an array
AType element. This is an array of responses for a payment
search.
Contains:
BilPaySchedPmtSrchInfo_CType
BilPaySchedPmtSrchInfo_CType
BilPaySchedPmtSrchInfo_CType is a complex
CType element. This is a package of data related to a
payment search.
Contains:
Custom_CTypePayFromAcctInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- P2PType
- Determines if this is a P2P type. Canonical values are:
- false
- true
- PayeeId
- The payee identifier.
- PayeeName
- The name of the payee.
- PayeeNickname
- The nickname given to a payee.
- PmtAmt
- The payment amount.
- PmtEstArvDt
- Estimated arrival date for a payment.
- PmtFreqUnits
- The frequency for a recurring payment. Canonical values are:
- Annual
- Every3Months
- Every6Months
- Every4Weeks
- EveryOtherMonth
- EveryOtherWeek
- Monthly
- Once
- TwiceMonthly
- Weekly
- PmtId
- The identification of a payment.
- 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.
- PmtMthd
- Payment method. Canonical values are:
- Chk - check
- Elec - electronic
- Email - electronic but set up via an email process
- PmtProcDt
- Process date for a payment.
- PmtStat
- The status of a payment. Canonical values are:
- All - all
- Canc - canceled
- Pd - paid
- Pend - pend
- PendSkip - pending skip
- Proc - processed
- Ret - returned
- Rfd - refunded
- Sched - scheduled
- Skip - skipped
- Stop - stopped
- Sttl - settled
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.
CardPayAcctInfo_CTypeNote: Do not expose the Card Pay Account Information in any inquiry or search service.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.
CardPayAcctInfo_CType
CardPayAcctInfo_CType is a complex CType element. This complex is a
package of data related to making a payment using a card. This information should only be
exposed in an add or mod service and should never be exposed in an inquiry or search
service.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CardExpDt
- The expiration date.
- CardSecCodeId
- The card security code also called card verification data. This element is typically used as a security feature.
- EmbosName
- The name that is embossed on the EFT card.
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.
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 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.