Bill Pay Scheduled Payment Add
Bill Pay Scheduled Payment Add
Bill Pay Scheduled Payment Add is a jXchange service designed to provide bill pay services by adding a scheduled payment.
Message Flow
In jXchange, the Bill Pay Scheduled
Payment Add service uses a typical exchange of MType messages to add a scheduled
payment.
Primary Request
The Third Party Consumer forwards the
BilPaySchedPmtAddRq_MType
message to the Service Provider. The message contains the following simple
elements:
BilPayProd- This element is optional, but it may be required by the Service Provider.SubId- This element is required.
The BilPaySchedPmtInfo complex is required,
however the child nodes within are all optional.
Primary Response
The Service Provider returns the
BilPaySchedPmtAddRs_MType
message to the Third Party Consumer. The message contains the new PmtId of the recently added
scheduled payment and RsStat, which is the status of
the request.
Bill Pay Scheduled Payment Add Behavior
The request requires a valid SubId simple
element to be submitted.
The BilPayPmtInfo_CType
complex is required on the request. The child nodes contained within it
are optional, though.
The BilPayProd simple element
is optional, but it may be required by the Service Provider.
The
Service Provider returns the new PayeeId, which is
generated by their application for the accepted new scheduled
payment.
BilPaySchedPmtAddRq_MType
BilPaySchedPmtAddRq_MType is a message
MType element.
Contains:
BilPayPmtInfo_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_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.
- SubId
- The ID of the subscriber or end user.
BilPayPmtInfo_CType
BilPayPmtInfo_CType is a complex
CType element. This is a
package of data related to a scheduled payment.
BilPaySvcFeeInfoRec_CTypeCustom_CTypeInvoiceInfoArray_ATypePmtPayFromAcctInforeferencesPayFromAcctInfo_CTypePmtPayeeInforeferencesBilPayPmtPayeeInfo_CTypePmtRushOptInforeferencesRushOptInfo_CTypeRecurPmtInforeferencesBilPayRecurPmtInfo_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.
BilPayPmtPayeeInfo_CType
BilPayPmtPayeeInfo_CType is a complex CType element. This is a package of data related to a bill pay payee of a
payment.
Custom_CTypePayeeAddrInfo_CTypePayeeEmailArrayreferencesEmailArray_ATypePayeePhoneArrayreferencesPhoneArray_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.
- 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
- 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.
- 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.
PayeeAddrInfo_CType
PayeeAddrInfo_CType is a complex
CType element. This is a package of data related to a payee
address.
PayeeAddrreferencesAddr_CTypeCustom_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.
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.
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
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.
InvoiceInfoArray_AType
InvoiceInfoArray_AType is an array
AType element. This is an array of invoices.
Contains:
InvoiceInfo_CType
InvoiceInfo_CType
InvoiceInfo_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- InvoiceAmtNeg
- The invoice amount that is negative.
- InvoiceAmtPos
- The invoice amount that is positive.
- InvoiceCat
- The category of an invoice. Canonical values are:
- Adj - adjustment
- Disc - discount
- Invoice - invoice
- Oth - other
- InvoiceDesc
- The description of an invoice.
- InvoiceId
- The ID of an invoice.
- InvoiceNum
- The number of an invoice.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PmtPayFromAcctInfo
PayFromAcctInfo_CType is a complex
CType element. This is a
package of data related to a pay from account.
PmtPayFromAcctInfo references
PayFromAcctInfo_CType.
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.
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_CTypePayeeAddrInfo_CTypePayeeEmailArrayreferencesEmailArray_ATypePayeePhoneArrayreferencesPhoneArray_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.
- 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
- 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.
- 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.
- EmailType
- Email type. Examples: Home, Work, Statement, Notice. Canonical
values are:
- Prim
- Secd
- OLB
EmailType is a hybrid open enumeration.
PayeeAddrInfo_CType
PayeeAddrInfo_CType is a complex
CType element. This is a package of data related to a payee
address.
PayeeAddrreferencesAddr_CTypeCustom_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.
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. Canonical values
are:
- Home
- SecdHome
- Bus
- SecdBus
- HomeCell
- BusCell
- PersonalCell
- HomeFax
- BusFax
- SecdBusCell
PhoneType is a hybrid open enumeration.
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 following simple elements are contained within this complex.
- RushOptFeeAmt
- The fee associated with the rush option.
- RushOpt
- Option for rushing a payment to a payee. Canonical values are:
- 2ndDay - second day
- 2ndDayEc - second day economy
- Ovrngt - overnight
- Std - standard
- RushOptSurChg
- The surcharge associated with the rush option.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RecurPmtInfo
BilPayRecurPmtInfo_CType
is a complex CType element. This is a package of data
related to a recurring scheduled payment.
RecurPmtInfo references
BilPayRecurPmtInfo_CType.
Contains:
Custom_CTypePmtDayInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- PayDtInstr
- The payment date instruction when recurrence date falls on a
non-processing date. Canonical values are:
- After
- Before
- PmtDayOfWeek
- The frequency for a recurring payment. Canonical values are:
- Mon
- Tues
- Wed
- Thur
- Fri
- PmtFinalAmt
- The payment amount.
- PmtFreqUnits
- The frequency for a recurring payment. Canonical values are:
- Annual
- Every3Months
- Every6Months
- Every4Weeks
- EveryOtherMonth
- EveryOtherWeek
- Monthly
- Once
- TwiceMonthly
- Weekly
- PmtOccur
- Number of occurrences for the payment to be made.
- PmtSerExpDt
- The expiration date for the recurring payment.
- PmtSerFinite
- The payment series is finite. Canonical values are:
- false
- true
- StartPmtEstArvDt
- The starting date for the estimated arrival of a recurring payment.
- StartPmtProcDt
- The starting date for processing a recurring payment.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PmtDayInfoArray_AType
PmtDayInfoArray_AType is an array
AType element. This is an array of the day of month to make
payments.
Contains:
PmtDayInfo_CType
PmtDayInfo_CType
PmtDayInfo_CType is a complex
CType element. This is a package of data related to the day
of month a payment should be made.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- PmtDayOfMonth
- The day of month for payment. This code is only required if the payment due date is the 29th of the month.
- PmtUseLastBusDay
- Use the last business day of the month. Canonical values are:
- false
- true
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.
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_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.
BilPaySchedPmtAddRs_MType
BilPaySchedPmtAddRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- PmtId
- The identification of a payment.
- RsStat
- The status of the response. Canonical values are:
- Fail
- Success
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 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.