Enterprise Solutions

Bill Pay Channel Inquiry

Enterprise SOAP API > API by Reference > Bill Pay Services > Bill Pay Channel Inquiry
Bill Pay Channel Inquiry

Bill Pay Channel Inquiry

Bill Pay Channel Inquiry is a jXchange service designed to provide element details related to a channel.

Message Flow

In jXchange, the Bill Pay Channel Inquiry service uses a typical exchange of MType messages to retrieve element details related to a channel.

Primary Request

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

  • BilPayProd
  • BilPayProdType

Primary Response

The Service Provider returns the BilPayChanInqRs_MType message to the Third Party Consumer. The message contains an echo of the elements sent in the request, even if those same elements exist in the repeating complex.

  • BilPayProd
  • BilPayProdType

It also contains the BilPayChanInfo_CType complex.

Bill Pay Channel Inquiry Behavior

This service returns element details as related to a channel.

BilPayChanInqRq_MType

BilPayChanInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_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.

BilPayProdType
The bill pay product type. Canonical values are:
  • Bus - business
  • Consm - consumer
  • iSB - service API

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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 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 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_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.

BilPayChanInqRs_MType

BilPayChanInqRs_MType is a message MType element.

Contains:

  • BilPayChanInfo_CType
  • Custom_CType
  • MsgRsHdr_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.

BilPayProdType
The bill pay product type. Canonical values are:
  • Bus - business
  • Consm - consumer
  • iSB - service API

BilPayChanInfo_CType

BilPayChanInfo_CType is a complex CType element. This is a package of data related to a bill pay channel.

Contains:

  • BilPayProdTypeInfoArray_AType
  • Custom_CType
  • NonProcDtInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

ChkFundModel
The check funding model. Canonical values are:
  • BilPayPrvdDrft - bill pay provider draft
  • InstDrft - institution draft
  • SubDrft - subscriber draft
ChkImgStorMos
Months for check images to be stored.
FinInstName
The depository financial institution name.
FundVerif
Answers the question: Are funds verified before sent? Canonical values are:
  • false
  • true
PmtCutoffTime
The Greenwich Mean Time when payments are cut off to next day.
StorMos
Months for information to be stored.

BilPayProdTypeInfoArray_AType

BilPayProdTypeInfoArray_AType is an array AType element. This is an array of bill pay product type details.

Contains:

  • BilPayProdTypeInfo_CType
BilPayProdTypeInfo_CType

BilPayProdTypeInfo_CType is a complex CType element. This is a package of data related to a bill pay product type.

Contains:

  • AlwSubAssocUsrMgmtOptInfoArray_AType
  • AvlCardBINArray_AType
  • BilPayFeturInfoArray_AType
  • SubLogInIdRstr_CType
Simple Elements

The following simple elements are contained within this complex.

AlwAddPayFromAcct
Allow additional pay from accounts. Canonical values are:
  • false
  • true
AlwSecdPerson
Allow secondary person to be added. Canonical values are:
  • false
  • true
AlwSubType
The allowed subscriber type. Canonical values are:
  • All - all
  • Comp - company
  • Indv - individual
BilPayProdType
The bill pay product type. Canonical values are:
  • Bus - business
  • Consm - consumer
  • iSB - service API
CanAddPayFromOwnInfo
Answers the question: Can you add pay from account owner information? Canonical values are:
  • false
  • true
CanPayFromSavAcct
Determines if you can add a savings account as a pay-from account. Canonical values are:
  • false
  • true
CanSetStartChkNum
Determines if the starting check number can be set. Canonical values are:
  • false
  • true
ConsmOwnSubUsrPer
Answers the question: Can the consumer handle all associated subscriber user permissions? Canonical values are:
  • false
  • true
DlyElecRiskLmt
Daily Electronic Risk Limit
DualSignOnReq
Determines if dual sign-on is required. Canonical values are:
  • false
  • true
ElecMerAutoPmtAlw
Answers the question: Are electronic bill auto payments allowed? Canonical values are:
  • false
  • true
HidSubAssocUsrConsmCustId
The consumer should hide the subscriber's associated user consumer's customer ID. Canonical values are:
  • false
  • true
MaxEmailDlyAmt
Maximum daily amount via email.
MaxEmailPmtAmt
Maximum payment amount via email.
MaxIndvDlyAmt
Maximum daily amount for payments to an individual.
MaxIndvPmtAmt
Maximum payment amount for payments to an individual.
MaxPmtAmt
The maximum payment amount.
MthlyElecRiskLmt
The Monthly Electronic Risk Limit.
PmtDtModel
The payment date model. Canonical values are:
  • DueDtModel - due date
  • ProcDtModel - process date
TaxIdReq
Determines if the Tax Id is a required field. Canonical values are:
  • false
  • true
AlwSubAssocUsrMgmtOptInfoArray_AType

AlwSubAssocUsrMgmtOptInfoArray_AType is an array AType element. This is an array of options for managing associated subscriber users.

Contains:

  • AlwSubAssocUsrMgmtOptInfo_CType
AlwSubAssocUsrMgmtOptInfo_CType

AlwSubAssocUsrMgmtOptInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AlwSubAssocUsrMgmtOpt
Allow option for managing associated subscriber users. Canonical values are:
  • Add - can add associated subscriber users
  • All - can do functions
  • Del - can delete associated subscriber users
  • Mod - can change associated subscriber users
  • None - cannot do any functions

The default is All.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

AvlCardBINArray_AType

AvlCardBINArray_AType is an array AType element. This is an array of Bank Identification Numbers (BIN) codes available for card payment.

Contains:

  • AvlCardBINInfo_CType
AvlCardBINInfo_CType

AvlCardBINInfo_CType is a complex CType element. This is a package of data related to available card Bank Identification Numbers (BIN).

Simple Elements

The following simple element is contained within this complex.

EFTCardBIN
The Bank Identification Number (BIN) codes.
BilPayFeturInfoArray_AType

BilPayFeturInfoArray_AType is an array AType element. This is an array of bill pay features.

Contains:

  • BilPayFeturInfo_CType
BilPayFeturInfo_CType

BilPayFeturInfo_CType is a complex CType element. This is a package of data related to a bill pay feature.

Contains:

  • SubTypeAccessFeturInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

FeturAct
Answers the question: Is this feature activated? Canonical values are:
  • false
  • true
FeturType
The feature type. Canonical values are:
  • AddPayee - add payee
  • AddSub - add (enroll) new subscribers (includes ability to add pay from accounts)
  • ElecBilPmt - electronic bill payment series
  • EmailPmt - email payment
  • MgmtPayee - manage payee
  • MgmtPayFromAcct - manage (add, edit, delete) pay from accounts
  • MgmtPendPmt - manage pending payments
  • MgmtRecurPmt - manage recurring series
  • MgmtSubInfo - manage subscriber information
  • RushPmt - rush payment
  • SchedRecurPmt - schedule a recurring series
  • SchedSinglePmt - schedule single payment
  • Subusers - manage (add) multiple users and subusers for bill pay account
  • ViewInstInfo - view institution information
  • ViewPayFromAcct - view pay from accounts
  • ViewPayee - view payees
  • ViewPendPmt - view pending payments
  • ViewPmtHist - view payment history
  • ViewSubInfo - view subscriber information
  • XferToSubFinInst - transfer to the subscriber's financial institution (outbound)
SubTypeAccessFeturInfoArray_AType

SubTypeAccessFeturInfoArray_AType is an array AType element. This is an array of subscriber types that can access a feature.

Contains:

  • SubTypeAccessFeturInfo_CType
SubTypeAccessFeturInfo_CType

SubTypeAccessFeturInfo_CType is a complex CType element. This is a package of data related to a subscriber type that can access a feature.

Simple Elements

The following simple elements are contained within this complex.

SubType
The subscriber type. Canonical values are:
  • Comp - company
  • Indv - individual
SubLogInIdRstr_CType

SubLogInIdRstr_CType is a complex CType element.

Contains:

  • SpecCharRstrArray_AType
Simple Elements

The following simple elements are contained within this complex.

MaxLenCharVal
The maximum number of characters that the credential type should contain.
MinAlphaCharVal
The minimum number of alphabetic characters (lower-case and upper-case) that the credential type can contain.
MinLenCharVal
The minimum number of characters that the credential type should contain.
MinLowCaseVal
The least number of lower case characters that the credential type can contain.
MinNumCharVal
The minimum number of numeric characters (0 through 9) that the credential type can contain.
MinSpecCharVal
The least number of special characters that the credential type can contain.
MinUpCaseVal
The minimum number of upper case characters that the credential type can contain.
SpecCharRstrArray_AType

SpecCharRstrArray_AType is an array AType element. This is an array of special characters not allowed for a credential type.

Contains:

  • SpecCharRstrRec_CType
SpecCharRstrRec_CType

SpecCharRstrRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

SpecCharRstrType
Special character types restricted for credential types.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

NonProcDtInfoArray_AType

NonProcDtInfoArray_AType is an array AType element. This is an array of non-processing dates.

Contains:

  • NonProcDtInfo_CType
NonProcDtInfo_CType

NonProcDtInfo_CType is a complex CType element. This is a package of data related to a non-processing date.

Simple Elements

The following simple elements are contained within this complex.

NonProcDt
A non-processing date.

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 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 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_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.

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.

©1999-2020 Jack Henry & Associates, Inc.

Dates are provided as estimates only and can be changed at any time at the sole discretion of JHA.

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