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

Credit Bureau Information Modification

Enterprise SOAP API > API by Reference > Core Services > Credit Bureau Information Modification

Credit Bureau Information Modification

Credit Bureau Information Modification is a jXchange service designed to modify credit bureau information on a loan.

Message Flow

In jXchange, the Credit Bureau Information Modification service uses a typical exchange of MType messages to modify credit bureau information on a service provider.

Primary Request

The third-party consumer forwards the CrBurInfoModRq_MType message to the service provider. The message contains ErrOvrRdInfoArray_AType, AccountId_CType, CrBurInfo_CType, and Dlt_CType.

Primary Response

The service provider returns the CrBurInfoModRs_MType message to the third-party consumer. The message contains RsStat, which states if the modification was successful.

CrBurInfoMod Behavior

The same behaviors of the Credit Bureau Information Addition service are duplicated for this service.

The complexes from the Credit Bureau Information Addition service are reused for the Credit Bureau Information Modification service and include the same tenants.

CrBurInfoModRq_MType

CrBurInfoModRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • CrBurInfo_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.

The Customer Identification is required if the credit bureau information is related to an indirect relationship to the account identification.

Dlt

The delete element. Canonical values are:

  • false
  • true

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

CrBurInfo_CType

CrBurInfo_CType is a complex CType element.

Contains:

  • DebtorAddr references Addr_CType
  • DebtorName references PersonName_CType
  • EmplAddr references Addr_CType
  • HouseHoldDebtorArray_AType
  • NonHouseHoldDebtorArray_AType
  • PmtHistArray_AType

Simple Elements

The following simple elements are contained within this complex.

BilDueDt
The due date for a specific bill.
BnkRptcyFileCode
The code that describes the type of filing for a bankruptcy claim.
ChgdOffAmt
The amount charged off.
ClsDt
The closing date.
CntryType
The country abbreviation from ISO 3166.
CrBurAcctClsfCode
Identifies the account classification.
CrBurActnCode
The code indicating the action that should be taken for an upload account to the credit bureau.
CrBurAddrRptCode
The code that describes the borrower's primary or business address.
CrBurCorrType
The credit bureau correction type. Canonical values are:
  • false
  • true
CrBurCplCode
The code that allows the reporting of the compliance condition that is required for legal compliance with the FCRA and FCBA (Fair Credit Billing Act).
CrBurCycleId
An identification given to cycles for credit bureau reporting.
CrBurFileMainCode
The code that designates the type of file maintenance that is being reported to the credit bureau.
CrBurId
The credit bureau identification provided by credit bureau agencies.
CrBurLnType
The credit bureau loan type. Canonical values are:
  • Install
  • LOC
  • Mtg
  • OpenEnd
  • Revol
CrBurOccupCode
The code that references the occupancy of the property.
CrBurPmtRateCode
The credit bureau payment rate code.
CrBurPrtcpCode
The code that references the participation position of the loan.
CrBurRptTimeDt
The credit bureau time date stamp.
CrBurSpecCmntCode
The code that references special information about the consumer classification for the account being reported to the credit bureau.
CrBurStatCode
The status code that properly identifies the current condition of the credit bureau account.
CrBurTermFreqType
The frequency of payments for credit bureau reporting. Canonical values are:
  • LOC
  • OpenEnd
  • Revol
CrBurTermType

The frequency for a recurring payment. Canonical values are:

  • Annual
  • Every3Months
  • Every6Months
  • Every4Weeks
  • EveryOtherMonth
  • EveryOtherWeek
  • Monthly
  • Once
  • TwiceMonthly
  • Weekly
CrBurTranCode
The code that describes the type of credit bureau activity to report to an agency.
CrClsfCode
The code indicating a general type of business for the creditor.
CurBal
The current balance.
DebtorBirthDt
The date of birth.
DebtorPhoneNum
The phone number.
DebtorTaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
DefPmtStartDt
The date that the first deferred loan payment starts.
DefRptType
Answers whether this loan should be reported as deferred. Canonical values are:
  • True
  • False
DlqDt
The date a loan became delinquent.
ECOACode
The ECOA code describes the borrower's relationship to the trade line. ECOA codes identify a trade as belonging to an individual, joint, co-signer, etc.
EmplName
The employer name.
LastPmtDt
The last payment date.
LiabInstName
The name of the institution that is obligated the funds owed for an individual.
MERSId
The identification that is used for the Mortgage Electronic Registration System (MERS).
NameSuffix
The name suffix. For examples, Jr. or MD.
NonCrBurRptRsn
The reason an account was not reported to the credit bureau.
OccType
The occupation description of the customer. Retail or bus.
ODHighBal
The highest overdraft balance amount.
ODLmt
The overdraft limit.
OpenDt
The date opened.
OrigAcctId
The original numbers or characters that identify an account record.
OrigCrBurId
The credit bureau identification provided by credit bureau agencies.
OvrrdCrBurStatCode
The status code that properly identifies the current condition of the credit bureau account.
PastDueAmt
The past due amount.
PmtAmt
The payment amount.
PmtAmtTot
The total of a loan's payments.
PmtExcpCode
The code that designates the payment exception rule.
PmtExcpDueDt
The date established for a scheduled payment.
PmtExcpStartDt
The date established for a scheduled payment.
PrtcpAcctId
The account ID of the master loan linked to the referenced loan.
PrtcpCompName
The name of the company or creditor that a loan was participated or purchased by.
SecdMktAgencyType
The secondary marketing agency that has interest in the loan. Canonical values are:
  • FannieMae
  • FreddieMac
  • Oth

DebtorAddr

Addr_CType is a complex CType element containing address information. This element is optional.

This complex contains employee address information.

DebtorAddr 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 address 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.
EmplAddr

Addr_CType is a complex CType element containing address information. This element is optional.

This complex contains employee address information.

EmplAddr 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 address 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.

DebtorName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

DebtorName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element 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.

EmplAddr

Addr_CType is a complex CType element containing address information. This element is optional.

This complex contains employee address information.

EmplAddr 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 address 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.

HouseHoldDebtorArray_AType

HouseHoldDebtorArray_AType is an array AType element.

Contains:

  • HouseHoldDebtorInfo_CType
HouseHoldDebtorInfo_CType

HouseHoldDebtorInfo_CType is a complex CType element.

Contains:

  • DebtorName references PersonName_CType
Simple Dictionary
DebtorBirthDt
The date of birth.
DebtorTaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
ECOACode
The ECOA code describes the borrower's relationship to the trade line. ECOA codes identify a trade as belonging to an individual, joint, co-signer, etc.
BnkRptcyFileCode
The code that describes the type of filing for a bankruptcy claim.
CrBurTranCode
The code that describes the type of credit bureau activity to report to an agency.
CrBurTranDesc
The description of the code that describes the type of credit bureau activity to report to an agency.
DebtorName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

DebtorName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element 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.

NonHouseHoldDebtorArray_AType

NonHouseHoldDebtorArray_AType is an array AType element.

Contains:

  • NonHouseHoldDebtorInfo_CType
NonHouseHoldDebtorInfo_CType

NonHouseHoldDebtorInfo_CType is a complex CType element.

Contains:

  • DebtorAddr references Addr_CType
  • DebtorName references PersonName_CType
Simple Dictionary
BnkRptcyFileCode
The code that describes the type of filing for a bankruptcy claim.
CrBurAddrRptCode
The code that describes the borrower's primary or business address.
CrBurAddrRptDesc
The description of the code that describes the borrower's primary or business address.
CrBurOccupCode
The code that references the occupancy of the property.
CrBurOccupDesc
The description of the code that references the occupancy of the property.
CrBurTranCode
The code that describes the type of credit bureau activity to report to an agency.
CrBurTranDesc
The description of the code that describes the type of credit bureau activity to report to an agency.
DebtorBirthDt
The date of birth.
DebtorPhoneNum
The phone number.
DebtorTaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
ECOACode
The ECOA code describes the borrower's relationship to the trade line. ECOA codes identify a trade as belonging to an individual, joint, co-signer, etc.
DebtorAddr

Addr_CType is a complex CType element containing address information. This element is optional.

This complex contains employee address information.

DebtorAddr 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 address 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.
EmplAddr

Addr_CType is a complex CType element containing address information. This element is optional.

This complex contains employee address information.

EmplAddr 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 address 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.
DebtorName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

DebtorName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This element 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.

PmtHistArray_AType

PmtHistArray_AType is an array AType element.

Contains:

  • PmtHistInfo_CType
PmtHistInfo_CType

PmtHistInfo_CType is a complex CType element.

Simple Dictionary
CalMonth
The calendar month. Canonical values are:
  • Jan
  • Feb
  • Mar
  • Apr
  • May
  • June
  • July
  • Aug
  • Sep
  • Oct
  • Nov
  • Dec
CalYr
The year for the calendar period.
PmtHistActType
The type of payment history activity for a loan. Canonical values are:
  • ChgdOff
  • Coll
  • Cur
  • ForeClosure
  • NoPmt
  • NoPmtAvl
  • PastDue30to59
  • PastDue60to89
  • PastDue90to119
  • PastDue120to149
  • PastDue150to179
  • PastDueGE180
  • Repos
  • VolSurr
  • ZeroBal

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.

CrBurInfoModRs_MType

CrBurInfoModRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

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_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 Thu Feb 8 2024