Bill Pay Subscriber Inquiry
Bill Pay Subscriber Inquiry
Bill Pay Subscriber Inquiry is a jXchange service designed to search for element details as related to a bill pay product.
Message Flow
In jXchange, the Bill Pay Subscriber
Inquiry service uses a typical exchange of MType messages to retrieve
element details as related to a bill pay product.
Primary Request
The Third Party Consumer forwards the
BilPaySubInqRq_MType
message to the Service Provider. The message contains the following simple
elements:
ActIntentBilPayProdSubId- This element is required.
Primary Response
The Service Provider returns the
BilPaySubInqRs_MType
message to the Third Party Consumer. The message contains the following
simple elements:
ActIntentActIntentKeyEnrollDtSubIdSubStat
It also contains the BilPaySubInfo_CType
complex.
Bill Pay Subscriber Inquiry Behavior
The response returns element details as related to a bill pay product.
The SubId simple element is required on the request.
The design of the inquiry 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 subscribers.
BilPaySubInqRq_MType
BilPaySubInqRq_MType is a message
MType element.
Contains:
Custom_CTypeMsgRqHdr_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.
- SubAssocUsrId
- The ID of the subscriber's associated user.
- SubId
- The ID of the subscriber or end user.
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_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.
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.
BilPaySubInqRs_MType
BilPaySubInqRs_MType is a message
MType element.
Contains:
BilPaySubInfo_CTypeCustom_CTypeMsgRsHdr_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.
- ActIntentKey
- The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
- EnrollDt
- The enrollment date.
- SubAssocUsrId
- The ID of the subscriber's associated user.
- SubComId
- The identification that is common between the provider and the consumer associated with a subscriber.
- SubConsmCustId
- The identification of the consumer's customer associated with a subscriber.
- SubId
- The ID of the subscriber or end user.
- SubStat
- The subscriber status. Canonical values are:
- Act - active
- Cls - closed
- InAct - inactive
- Pend - pending
The default value is Act.
BilPaySubInqRs_MType Deprecation Details
- SubStat
- The subscriber status. Canonical values are:
- Act - active
- Cls - closed
- InAct - inactive
- Pend - pending
The default value is Act.
This element is scheduled for deprecation from the BilPaySubInqRs_MType.
Effective date: 2018-01-01.
BilPaySubInfo_CType
BilPaySubInfo_CType is a complex
CType element. This is a
package of data related to a bill pay subscriber.
Contains:
Addr_CTypeCustom_CTypeEmailArray_ATypeMktgOptInfoArray_ATypePayFromAcctInfoArray_ATypePersonName_CTypePhoneArray_ATypeSecdPersonArrayreferencesAcctTitle_ATypeSubAssocUsrInfoArray_ATypeSubConsmCapArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BirthDt
- The date of birth.
- PmtApprvReq
- Payments added require approval from another subscriber associated
user. Canonical values are:
- false
- true
- PswdChgFreq
- The frequency that passwords should be changed. Canonical values
are:
- Mthly - change the password monthly
- None - not required to change password
- Qtr - change the password quarterly
- Weekly - change the password weekly
The default is None.
- SubComId
- The identification that is common between the provider and the consumer associated with a subscriber.
- SubConsmCustId
- The identification of the consumer's customer associated with a subscriber.
- SubInActRsnType
- Identifies the reason a subscriber was moved to inactive.
Canonical values are:
- AdminAcctCls
- AdminFraudAct
- AdminPoorAcct
- SubRq
- SubStat
- The subscriber status. Canonical values are:
- Act - active
- Cls - closed
- InAct - inactive
- Pend - pending
The default value is Act.
- SubType
- The subscriber type. Canonical values are:
- Comp - company
- Indv - individual
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - TempPswd
- The temporary password.
Addr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
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? 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.
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.
- EmailType
- E-mail type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
MktgOptInfoArray_AType
MktgOptInfoArray_AType is an array
AType element. This is an array of marketing options.
Contains:
MktgOptInfo_CType
MktgOptInfo_CType
MktgOptInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MktgOptType
- The option type. Canonical values are:
- MktgOptVal
- The option value. Canonical values are:
- Accept
- Decline
PayFromAcctInfoArray_AType
PayFromAcctInfoArray_AType is an array
AType element. This is an array of pay from
accounts.
Contains:
PayFromAcctInfo_CType
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.
PersonName_CType
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
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.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell.
SecdPersonArray
AcctTitleArray_AType is an array AType element. This is an array of
account titles used to define the customer and additional names. This element is
optional.
SecdPersonArray
references AcctTitleArray_AType.
Contains:
AcctTitleInfo_CType
AcctTitleInfo_CType
AcctTitleInfo_CType is a complex
CType element.
Simple Elements
Contains:
AddlNamereferencesPersonName_CTypeAddlPhoneArrayreferencesPhoneArray_ATypeAddlTINreferencesTINInfo_CType
The following simple elements are contained within this complex.
- AcctTitle
- The account title including customer name and additional
names.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- AddlBirthDt
- The date of birth.
- AddlNameStat
- The additional person status. Canonical values are:
- Act - active
- NotAct - not active
The ComName element is contained by the AddlName complex and
replaces the AcctTitleAcctTitle is 2012-01-01.
AddlName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
AddlName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
AddlPhoneArray
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.
AddlPhoneArray references PhoneArray_AType.
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.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell.
AddlTIN
TINInfo_CType is a complex
CType element. This element contains tax information number
codes and descriptions. This element is optional.
AddlTIN references TINInfo_CType.
Contains:
TaxIdOwnerNamereferencesPersonName_CType
Simple Elements
The following simple elements are contained within this complex.
- BNotIRSDt
- The last IRS notification.
- BNotStat
- The B notice flag.
- CertCodeDesc
- The description of the code that represents the certification behavior for a tax ID.
- CertCodeDt
- The certification code date.
- CertCode
- The code that represents the certification behavior for a tax ID.
- TaxIdMod
- A tax ID modifier assigned by the SSA to some individuals.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - TINCode
- The code that designates the type of tax identification number.
- TINDesc
- The description of the code that designates the type of tax identification number.
TaxIdOwnerName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
TaxIdOwnerName references PersonName_CType.
The TaxIdOwnerName
is optional and is only required when the customer level tax ID is different than the
account level.
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SubAssocUsrInfoArray_AType
SubAssocUsrInfoArray_AType is an
array AType element. This is an array of associated subscriber
users.
Contains:
SubAssocUsrInfo_CType
SubAssocUsrInfo_CType
SubAssocUsrInfo_CType is a
complex CType element.
Contains:
Custom_CTypeSubAssocUsrCapInfoArray_ATypeSubAssocUsrEmailArrayreferencesEmailArray_ATypeSubAssocUsrMktgOptInfoArrayreferencesMktgOptInfoArray_ATypeSubAssocUsrNamereferencesPersonName_CTypeSubAssocUsrPerInfoArray_ATypeSubAssocUsrPhoneArrayreferencesPhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- SubAssocUsrCmnt
- A comment for a subscriber's associated user.
- SubAssocUsrComId
- The identification that is common between the provider and the consumer associated with a subscriber.
- SubAssocUsrConsmCustId
- The identification of the consumer's customer associated with a subscriber.
- SubAssocUsrId
- The ID of the subscriber's associated user.
- SubAssocUsrRole
- The role of a subscriber's associated user. Canonical values
are:
- Prim - primary role
- SubAssocUsrTempPswd
- The temporary password.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SubAssocUsrCapInfoArray_AType
SubAssocUsrCapInfoArray_AType is
an array AType element. This is an array of options for caps of associated
subscriber users.
Contains:
SubAssocUsrCapInfo_CType
SubAssocUsrCapInfo_CType
SubAssocUsrCapInfo_CType is a
complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CapAmt
- The cap amount.
- CapAssocPayeeId
- The cap associated payee ID.
- CapCode
- The cap code.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SubAssocUsrEmailArray
EmailArray_AType is an array AType element. This is an array used to define email contact
information.
SubAssocUsrEmailArray references EmailArray_AType.
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.
- EmailType
- E-mail type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
SubAssocUsrMktgOptInfoArray
MktgOptInfoArray_AType is an array
AType element. This is an array of marketing options.
SubAssocUsrMktgOptInfoArray references
MktgOptInfoArray_AType.
Contains:
MktgOptInfo_CType
MktgOptInfo_CType
MktgOptInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MktgOptType
- The option type. Canonical values are:
- MktgOptVal
- The option value. Canonical values are:
- Accept
- Decline
SubAssocUsrName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
SubAssocUsrName references PersonName_CType.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AbbName
- An abbreviated individual's or entity's name.
- LegalName
- Used by entities like trusts, or businesses in the case where
an individual is doing business as a company, or when the legal name is
different than the
ComName. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SubAssocUsrPerInfoArray_AType
SubAssocUsrPerInfoArray_AType is
an array AType element. This is an array of options for permissions of
associated subscriber users.
Contains:
SubAssocUsrPerInfo_CType
SubAssocUsrPerInfo_CType
SubAssocUsrPerInfo_CType is a
complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- PerCode
- The permission code.
- PerValue
- The permission value.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SubAssocUsrPhoneArray
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.
SubAssocUsrPhoneArray references PhoneArray_AType.
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.
- PhoneNumDsp
- Phone Number Display, based on format codes which may include
special formatting. Examples include:
- (XXX)XXX-XXXX
- XXX-XXX-XXXX
- XXX/XXX/XXXX
- XXX.XXX.XXXX
- XXX-XXX-XXXXXX
- XXXXX-XXX-XXX-XXXX
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell.
MobPhoneInfo_CType
MobPhoneInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MobBB
- Answers the question: Is the mobile phone a Blackberry? Canonical
values are:
- false
- true
- MobPrvdCode
- The provider code for the mobile service.
- MobPrvdCodeDesc
- The description of the provider code for the mobile service.
- MobPrvdDom
- The domain of the provider of the mobile service.
- MobSendTestText
- Send a test text. Canonical values are:
- false
- true
SubConsmCapArray_AType
SubConsmCapArray_AType is an array AType element. This is an array of
consumer cap information.
Contains:
SubConsmCapInfo_CType
SubConsmCapInfo_CType
SubConsmCapInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CapAmt
- The cap amount.
- CapCode
- The cap code.
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_CTypeMsgRecInfoArray_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_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.