Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Bill Pay Payee Modify

Enterprise SOAP API > API by Reference > Bill Pay Services > Bill Pay Payee Modify

Bill Pay Payee Modify

Bill Pay Payee Modify is a jXchange service designed to modify bill pay services for a payee.

Message Flow

In jXchange, the Bill Pay Payee Modify service uses a typical exchange of MType messages to modify a payee's bill pay services.

Primary Request

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

  • ActIntentKey
  • BilPayProd
  • Dlt
  • PayeeId
  • SubId

It also contains the BilPayPayeeInfo_CType complex and ErrOvrRdInfoArray_AType array.

Primary Response

The Service Provider returns the BilPayPayeeModRs_MType message to the Third Party Consumer. The message contains the RsStat, which is the status of the request.

Bill Pay Payee Modify Behavior

The request requires a valid SubId simple element to be submitted.

A request that provides the SubId and ActIntentKey simple elements, along with the Dlt simple element set to true conveys to the service provider to remove the payee for the associated subscriber.

The ElecMerPayeeInfoRec_CType complex, ElecMerAcctErrCode element, and PayeeModId element are part of the documented choice statement that includes the BilPayPayeeInfo_CType complex and Dlt element.

The ElecMerAcctErrCode element can be cached from the Bill Pay Payee Inquiry message.

The service provider returns a message error with the MsgCat canonical value as ~Fault~ to be able to provide the consumer with information related to the error. This could optionally include the AuthenQuesArray_AType array or the ElecMerAcctIdArray_AType array.

The ElecMerAcctIdArray_AType array represents the merchants account identifications related to the Bill Pay subscriber when the service provider is not able to make an exact match to the account identification being registered for the subscriber. The ElecMerAcctIdArray_AType array encapsulates the ElecMerAcctId, SubMerAcctId, ElecMerAcctAliasName, and ElecMerAcctBal elements. This permits the consumer to present the accounts so the subscriber can register the correct account identification.

The ElecMerAcctIdArray_AType array is a matched pair value array where the ElecMerAcctId element is required. The service provider generates a unique ElecMerAcctId to be used in a subsequent modification enabling the consumer to submit the correct account to be registered.

BilPayPayeeModRq_MType

BilPayPayeeModRq_MType is a message MType element.

Contains:

  • BilPayPayeeInfo_CType
  • Custom_CType
  • ElecMerPayeeInfoRec_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

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.

Dlt
The delete element. Canonical values are:
  • false
  • true
ElecMerAcctErrCode
The Soap Header Fault error code.
PayeeId
The payee identifier.
PayeeModId
An identification provided for a payee modification request to be used for a subsequent message.
SubId
The ID of the subscriber or end user.

BilPayPayeeInfo_CType

BilPayPayeeInfo_CType is a complex CType element. This is a package of data related to a bill pay payee.

Contains:

  • BilPaySvcFeeArray_AType
  • Custom_CType
  • PayeeAddrInfoArray_AType
  • PayeeEmailArray references EmailArray_AType
  • PayeeFIAcctInfo references FIAcctInfo_CType
  • PayeePhoneArray references PhoneArray_AType
  • PayFromAcctInfo_CType

Simple Elements

The following simple elements are contained within this complex.

ElecBilAcctErrExist
Answers the question: Does the payee have any outstanding account errors related to electronic merchant billing? Canonical values are:
  • false
  • true
ElecBillPayeeCatType
The electronic bill payee category. Canonical values are:
  • Det
  • Sum
ElecBilPayeeType
The type of electronic billing payee type. Canonical values are:
  • Alw
  • Enroll
  • EnrollAlw
  • EnrollPend
  • NotAlw
LastMainDt
The last maintenance date.
PayeeCatName
The category name assigned to a payee.
PayeeClsf
The classification of a payee. Canonical values are:
  • Comp
  • FinInst
  • Indv
PayeeEmailSharedSecret
A shared secret associated with the payee's email.
PayeeName
The name of the payee.
PayeeNickname
The nickname given to a payee.
PayeeP2PType
The type of method used for person-to-person payee contact. Canonical values are:
  • Email
  • SMS
PmtIntentType
The payment intention type. Canonical values are:
  • PayBill - payment for a bill
  • XferToSubFinInst - transfer to the subscriber's financial institution (outbound)
  • XferFromSubFinInst - transfer from the subscriber's financial institution (inbound)
  • XferTo - internal transfer to subscriber's account
  • XferFrom - internal transfer from subscriber's account

The default value is PayBill.

SubMerAcctId
The subscriber's account identifier at the merchant.
SubMerPayeeName
The subscriber's name understood by the merchant and used to override the subscriber's name on record.

BilPaySvcFeeArray_AType

BilPaySvcFeeArray_AType is an array AType element. This is an array of service fees related to a bill pay payee.

Contains:

  • BilPaySvcFeeInfoRec_CType
BilPaySvcFeeInfoRec_CType

BilPaySvcFeeInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

SvcFeeAmt
The fee amount of the loan for some categories.
SvcFeeCode
The code that identifies the type of service fee applied to an account identification.
SvcFeeDesc
The description of the code that identifies the type of service fee applied.
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.

PayFromAcctInfo_CType

PayFromAcctInfo_CType is a complex CType element. This is a package of data related to a pay from account.

Contains:
  • CardPayAcctInfo_CType
    Note: 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.

PayeeAddrInfoArray_AType

PayeeAddrInfoArray_AType is an array AType element. This is an array of payee addresses.

Contains:

  • PayeeAddrInfo_CType
PayeeAddrInfo_CType

PayeeAddrInfo_CType is a complex CType element. This is a package of data related to a payee address.

Contains:
  • PayeeAddr references Addr_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 code.
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 two-character alpha 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.

PayeeEmailArray

EmailArray_AType is an array AType element. This is an array used to define email contact information.

PayeeEmailArray 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
Email type. Examples: Home, Work, Statement, Notice. Canonical values are:
  • Prim
  • Secd
  • OLB

EmailType is a hybrid open enumeration.

PayeeFIAcctInfo

FIAcctInfo_CType is a complex CType element. This is a package of data that groups needed data for an account at a financial institution.

PayeeFIAcctInfo references FIAcctInfo_CType.
Contains:
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

FIAcctId
The number or character that identifies an account record.
FIAcctType
The number or character that categorizes the AcctId.
FIRtId
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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PayeePhoneArray

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.

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

Contains:
  • 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. Canonical values are:
  • Home
  • SecdHome
  • Bus
  • SecdBus
  • HomeCell
  • BusCell
  • PersonalCell
  • HomeFax
  • BusFax
  • SecdBusCell

PhoneType is a hybrid open enumeration.

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

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ElecMerPayeeInfoRec_CType

ElecMerPayeeInfoRec_CType is a complex CType element. The details related to an electronic merchant payee.

Contains:

  • AuthenQuesArray_AType
  • Custom_CType
  • ElecMerAcctTypeInfoArray_AType
  • ElecMerAcctErrInfoArray_AType
  • ElecMerPayeeCredInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

ElecBilPayeeAcctId
The numbers or characters that identify an account record.
ElecBilPayeeName
The name of the payee.
ElecBilPmtAmt
The payment amount.
ElecBilPmtAmtType
The electronic billing accepted payment amount options. Canonical values are:
  • AmtDue
  • FixedAmt
  • MinDue
  • StmtBal
ElecBilPmtInstrType
The electronic bill payment instructions. Canonical values are:
  • ElecBilDueDt
  • ElecMerStmt
ElecBilPmtRuleAlgSymb
The algebraic symbol for the electronic billing payment rules. Canonical values are:
  • EQ
  • GE
  • GT
  • LE
  • LT
  • NE
ElecMerAcctStat
The status of the electronic merchant account. Canonical values are:
  • Act
  • PendTer
  • Susp
ElecMerAutoPmtAlw
Answers the question: Are electronic bill auto payments allowed? Canonical values are:
  • false
  • true
ElecMerAutoSuspType
The electronic merchant automatic suspended type. Canonical values are:
  • NxtBil
  • Perm
ElecMerPayeeId
The payee identifier.
ElecMerPayeeToSStat
The status of the electronic merchant payee terms of service. Canonical values are:
  • Actp
  • NotActp
  • ReqNewActp
ElecMerPayeeToS
The electronic merchant payee terms of service.
ElecMerPayeeURL
The URL that contains the merchant payee electronic address.
ElecMerPendTerDt
The electronic merchant pending termination date.
ElecMerSuspExpDt
The electronic merchant suspended expiration date.

AuthenQuesArray_AType

AuthenQuesArray_AType is an array AType element. This is an array of MFA authentication questions.

Contains:

  • AuthenQuesRec_CType
AuthenQuesRec_CType

AuthenQuesRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuthenAnswDesc
The answer that coincides with the question as part of the array.
AuthenQuesCode
The code assigned to the user authentication questions.
AuthenQuesDesc
The description of the code assigned to the user authentication questions.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ElecMerAcctErrInfoArray_AType

ElecMerAcctErrInfoArray_AType is an array AType element. This is an array of electronic merchant errors that require remediation.

Contains:

  • ElecMerAcctErrInfoRec_CType
ElecMerAcctErrInfoRec_CType

ElecMerAcctErrInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ElecMerAcctErrCode
The Soap Header Fault error code.
ElecMerAcctErrDesc
The Soap Header Fault error description.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ElecMerAcctTypeInfoArray_AType

ElecMerAcctTypeInfoArray_AType is an array AType element. This is an array of electronic merchant account types.

Contains:

  • ElecMerAcctTypeInfoRec_CType
ElecMerAcctTypeInfoRec_CType

ElecMerAcctTypeInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ElecMerAcctType
The numbers or characters that categorize the AcctId.
ElecMerAcctTypeDesc
A description of the account type.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ElecMerPayeeCredInfoArray_AType

ElecMerPayeeCredInfoArray_AType is an array AType element. This is an array of electronic merchant payee credential requirements.

Contains:

  • ElecMerPayeeCredInfoRec_CType
ElecMerPayeeCredInfoRec_CType

ElecMerPayeeCredInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ElecMerCredRegEx
The variable RegEx validation.
ElecMerCredTypeDesc
A human readable text description of the electronic merchant type of credential for user interface purposes.
ElecMerCredType
The electronic merchant credential type. Canonical values are:
  • Pswd
  • SharedSecret
  • UsrName
ElecMerCredVal
The electronic merchant credential type value.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType

ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

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.

BilPayPayeeModRs_MType

BilPayPayeeModRs_MType is a message MType element.

Contains:

  • AuthenQuesArray_AType
  • Custom_CType
  • ElecMerAcctIdArray_AType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

PayeeModId
An identification provided for a payee modification request to be used for a subsequent message.
RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

AuthenQuesArray_AType

AuthenQuesArray_AType is an array AType element. This is an array of MFA authentication questions.

Contains:

  • AuthenQuesRec_CType

AuthenQuesRec_CType

AuthenQuesRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuthenAnswDesc
The answer that coincides with the question as part of the array.
AuthenQuesCode
The code assigned to the user authentication questions.
AuthenQuesDesc
The description of the code assigned to the user authentication questions.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ElecMerAcctIdArray_AType

ElecMerAcctIdArray_AType is an array AType element. This is an array of electronic bill payee account identifications.

Contains:

  • ElecMerAcctIdInfoRec_CType

ElecMerAcctIdInfoRec_CType

ElecMerAcctIdInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ElecMerAcctAliasName
An alias name provided to an account that is often used for GUI representation that is understandable to an end consumer.
ElecMerAcctBal
The current balance.
ElecMerAcctId
The numbers or characters that identify an account record.
SubMerAcctId
The subscriber's account identifier at the merchant.
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 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.
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 Mon Jan 24 2022