Bill Pay Scheduled Payment Inquiry
Bill Pay Scheduled Payment Inquiry is a jXchange service designed to return details about a scheduled payment.
Message Flow
In jXchange, the Bill Pay Scheduled
Payment Inquiry service uses a typical exchange of MType
messages to retrieve
information about a scheduled payment for a subscriber.
Primary Request
The Third Party Consumer forwards the
BilPaySchedPmtInqRq_MType
message to the Service Provider. The message contains the following simple
elements:
ActIntent
BilPayProd
PmtId
- This element is required.SubId
- This element is required.
Primary Response
The Service Provider returns the
BilPaySchedPmtInqRs_MType
message to the Third Party Consumer. The message contains the following
simple elements:
ActIntent
ActIntentKey
PmtCrtDt
PmtMthd
PmtStat
PmtId
SubId
It also contains the BilPaySchedPmtInfo
complex.
Bill Pay Scheduled Payment Inquiry Behavior
The response returns element details related to a scheduled payment for a subscriber.
The SubId
and
PmtId
simple elements are required on the request. The
design of this inquiry service was created in a manner to leverage the
addition and modification.
The ActIntent
simple
element was added to support the concurrency model for future
modifications made to scheduled payments.
BilPaySchedPmtInqRq_MType
BilPaySchedPmtInqRq_MType
is a message
MType
element.
Contains:
Custom_CType
IncXtendElemArray_AType
MsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
- Conveys the consumer intention for a subsequent operation for the data set included in
the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- BilPayProd
- Used to show which product to use. Canonical values are:
- BilPay - Bill Pay
- Remit - Remittance
The default value is BilPay.
- PmtId
- The identification of a payment.
- SubId
- The ID of the subscriber or end user.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType
is an array
AType
element.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
MsgRqHdr_CType
MsgRqHdr_CType
is a complex CType
element. This is the default
message request 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.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-Security
.
BilPaySchedPmtInqRs_MType
BilPaySchedPmtInqRs_MType
is a message
MType
element.
Contains:
BilPayeeElecPmtInfo_CType
BilPaySchedPmtInfo
referencesBilPayPmtInfo_CType
Custom_CType
MsgRsHdr_CType
x_FutPmtInfoArray_AType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
- Conveys the consumer intention for a subsequent operation for the data set included in
the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- ActIntentKey
- The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
- BilPayProd
- Used to show which product to use. Canonical values are:
- BilPay - Bill Pay
- Remit - Remittance
The default value is BilPay.
- PmtCrtDt
- The date a payment created by the end user.
- PmtMthd
- Payment method. Canonical values are:
- Chk - check
- Elec - electronic
- Email - electronic but set up via an email process
- PmtStat
- The status of a payment. Canonical values are:
- All - all
- Canc - cancelled
- Pd - paid
- Pend - pend
- PendSkip - pending skip
- Proc - processed
- Ret - returned
- Rfd - refunded
- Sched - scheduled
- Skip - skipped
- Stop - stopped
- Sttl - settled
- PmtId
- The identification of a payment.
- SubId
- The ID of the subscriber or end user.
BilPayeeElecPmtInfo_CType
BilPayeeElecPmtInfo_CType
is a complex
CType
element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CurBal
- The current balance.
- ElecBilPmtAuto
- Answers the question: Was the electronic bill payment made automatically? Canonical
values are:
- false
- true
- 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.
BilPaySchedPmtInfo
BilPayPmtInfo_CType
is a complex
CType
element. This is a
package of data related to a scheduled payment.
BilPaySchedPmtInfo
references
BilPayPmtInfo_CType
.
BilPaySvcFeeInfoRec_CType
Custom_CType
InvoiceInfoArray_AType
PmtPayFromAcctInfo
referencesPayFromAcctInfo_CType
PmtPayeeInfo
referencesBilPayPmtPayeeInfo_CType
PmtRushOptInfo
referencesRushOptInfo_CType
RecurPmtInfo
referencesBilPayRecurPmtInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- PmtAmt
- The payment amount.
- PmtChkMemo
- The memo to be added to a check associated with a payment.
- PmtCmnt
- The comment associated with a payment.
- PmtEstArvDt
- Estimated arrival date for 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.
- PmtProcDt
- Process date for a payment.
- SubCmntToPayee
- Application or user remarks free form text.
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.
PmtPayeeInfo
BilPayPmtPayeeInfo_CType
is a complex CType
element. This is a package of data related to a bill pay payee of a
payment.
PmtPayeeInfo
references BilPayPmtPayeeInfo_CType
.
Custom_CType
PayeeAddrInfo_CType
PayeeEmailArray
referencesEmailArray_AType
PayeePhoneArray
referencesPhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- PayeeCatName
- The category name assigned to a payee.
- PayeeClsf
- The classification of a payee. Canonical values are:
- Comp
- FinInst
- Indv
- PayeeId
- The payee identifier.
- 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.
- 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
- SubMerAcctId
- The subscriber's account identifier at the merchant.
- SubMerPayerName
- The subscriber's name understood by the merchant and used to override the subscriber's name on record.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
EmailArray_AType
EmailArray_AType
is an array
AType
element. This is an
array used to define email contact information.
Contains:
EmailInfo_CType
EmailInfo_CType
EmailInfo_Ctype
is a complex
CType
element. This element is optional.
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- E-mailType
- Email type. Examples: Home, Work, Statement, Notice.
PayeeAddrInfo_CType
PayeeAddrInfo_CType
is a complex
CType
element. This is a package of data related to a payee
address.
PayeeAddr
referencesAddr_CType
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- PayeeAddrId
- The payee address identifier.
- PayeeAddrType
- Type of payee address. Canonical values are:
- Prim
- Rush
PayeeAddr
Addr_CType
is a complex
CType
element containing address information. This element
is optional.
PayeeAddr
references
Addr_CType
.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the zip.
- FornAddr
- Is this a foreign address? Where Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The 2 alpha long code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType
is an array AType
element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free form element of address lines 1 - 11 in a printable/usable form, generally not separated.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
PhoneArray_AType
PhoneArray_AType
is an array AType
element. This array contains one or more PhoneInfo_CType
complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType
is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell.
PmtRushOptInfo
RushOptInfo_CType
is a complex
CType
element. This is a
package of data related to a rush option.
PmtRushOptInfo
references
RushOptInfo_CType
.Custom_CType
Simple Elements
The simple elements contained within this complex are listed below.- RushOpt
- Option for rushing a payment to a payee. Canonical values are:
- 2ndDay - second day
- 2ndDayEc - second day economy
- Ovrngt - overnight
- Std - standard
- RushOptFeeAmt
- The fee associated with the rush option.
- 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.
MsgRsHdr_CType
MsgRsHdr_CType
is a complex
CType
element. This is the default message response
header.
Contains:
jXchangeHdr_CType
MsgRecInfoArray_AType
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-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.
x_FutPmtInfoArray_AType
x_FutPmtInfoArray_AType
is an array
AType
element. This is an array of future payments.
Contains:
FutPmtInfo_CType
FutPmtInfo_CType
FutPmtInfo_CType
is a complex
CType
element. This is a package of data related to a
future scheduled payment.
Contains:
Custom_CType
FutPmtPayFromAcctInfo
referencesPayFromAcctInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- FutPmtActualProcDt
- Process date for a payment.
- FutPmtAmt
- The payment amount.
- FutPmtChkMemo
- The memo to be added to a check associated with a payment.
- FutPmtCmnt
- The comment associated with a payment.
- FutPmtId
- The identification of a payment.
- FutPmtLastMainDt
- The last maintenance date.
- FutPmtModUsrId
- The user or indicator that modified the future payment.
- FutPmtOrigProcDt
- A future payment's original payment date.
- FutPmtStat
- The status of a payment. Canonical values are:
- All - all
- Canc - cancelled
- Pd - paid
- Pend - pend
- PendSkip - pending skip
- Proc - processed
- Ret - returned
- Rfd - refunded
- Sched - scheduled
- Skip - skipped
- Stop - stopped
- Sttl - settled
- SubCmntToPayee
- Application or user remarks free form text.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
FutPmtPayFromAcctInfo
PayFromAcctInfo_CType
is a complex
CType
element. This is a
package of data related to a pay from account.
FutPmtPayFromAcctInfo
references
PayFromAcctInfo_CType
.
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.