Account Product Override Addition
Account Product Override Addition
Account Product Override Addition is a jXchange service designed to allow the consumer to add account product overrides.
Message Flow
In jXchange, the Account Product Override Addition service uses a typical exchange
of MType messages to add
account product overrides on a service provider.
Primary Request
The consumer forwards the message AcctProdOvrrdAddRq_MType to the
service provider. The message contains the following elements:
AccountId_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CType
Primary Response
The service provider returns the AcctProdOvrrdAddRs_MType message
to the consumer. The message contains the following elements:
AcctProdOvrrdInfoRec_CTypeMsgRsHdr_CType
Account Product Override Addition Behavior
| Element Title | Element Name | Description |
|---|---|---|
| Account Identification | AccountId_CType | Required for the addition service. |
| Account Product Override Information | AcctProdOvrrdInfoRec_CType | Required for the addition service. |
| Product Base Information | ProdBaseInfoRec_CType | A limited set of elements that were not categorized into other complexes. |
| Transaction History Retention Days Type | TrnHistTrnDaysType | Defaults only when the Transaction History Retention Days element, TrnHistRtnDays, is provided. |
| Overdraft Information | ODInfoRec_CType | Contains those elements that pertain to overdraft charges. |
| Overdraft Charge Calculation Type | ODChgCalcType | Defaults only when the Overdraft Index Number element, ODIdxNum, is provided. |
| Federal Deposit Insurance Corporation (FDIC) Information | FDICInsurInfoRec_CType | Contains those elements that pertain to FDIC insurance charges. |
| FDIC Insurance Charge Calculation Type | FDICInsurChgCalcType | Defaults only when the FDIC Insurance Charge Rate element, FDICInsurChgRate, is provided. |
| Transfer Information | XferInfoRec_CType | Contains those elements that pertain
to transfer services defaults. This complex contains the Transfer
EFT Description Array, XferEFTDescArray_AType,
for EFT description defaults. |
| Reduction of Service Charge Information | RedSerChgInfoRec_CType | Describes the behavior for the
reduction of service charges, which includes 100% waive. This
complex includes the Reduction of Service Charge Method Array,
RedSerChgMthdArray_AType,
that differentiates between the amount and the rate method. The
Reduction Service Charge Method Type, RedSerChgMthdType, serves
as the key for the array and is required. |
| EFT Charge Information Array | EFTChgInfoArray_AType | Allows the consumer to submit service charges based on electronic transactional activity. |
| EFT Transactional Activity Type | EFTTrnActType | Serves as the key that defines the type of EFT transaction. This element is required. The EFT Transactional Type element, EFTTrnType, may further define the type of EFT Transaction. |
| EFT Transactional Activity Type | EFTTrnActType | When submitted without the EFT Transactional Type element, EFTTrnType, conveys to include all the EFT transaction types for that EFT transaction activity. |
| Excess Debit Charge Information Array | XsDrChgInfoArray_AType | Allows the consumer to submit the service charges based on excess debit transactional activity. |
| Excess Debit Transaction Type | XsDrTrnType | Serves as the key that defines the type of excess debit activity. This element is required. |
| Service Charge Tier Information Array | SerChgTierInfoArray_AType | Allows the consumer to submit service charges that are tiered based on charges. There is a relationship between the tiered records that allow some tiers to be combined and others as an option. |
| Tier Charge Order | TierChgOrder | Provides the sequential order of charges for the tier arrangement and references the element Order, which is required. |
| Tier Charge Logical Operand | TierChgLgclOprnd | Provides the method of combining related tier charges. The default value is Or. |
| Service Charge Tier Balance Information Array | SerChgTierBalInfoArray_AType | Contained within the Service Charge Tier Information Array, SerChgTierInfoArray_AType.
This array is included to provide the balance qualifications for the tier service
charge. |
| Tier Charge Order | TierChgOrder | Provided to give an order to the balance qualifications and is required. The relationship of the balance qualifications is And. |
| Transactional Activity Tier Information Array | TrnActTierInfoArray_AType | Allows the consumer to submit charges based on transactional activity. |
| Tier Transactional Activity Type | TierTrnActType | Serves as the key that defines the type of transaction. This element is required. The Tier Transactional Type element, TierTrnType, may further define the type of transaction. |
| Tier Transactional Activity Type | TierTrnActType | When submitted without the Tier Transactional Type element, TierTrnType, conveys to include all the transaction types for that transactional activity. |
| Tier Activity Balance Information Array | TierActBalInfoArray_AType | Contained by the Transaction
Activity Tier Information Array, TrnActTierInfoArray_AType.
These arrays provide the balance thresholds for the assessment of
service charges. The behavior for the TierActBalInfoArray_AType
mimics that of the Service Charge Tier balance Information Array,
SerChgTierBalInfoArray_AType. |
| Tier Charge Order | TierChgOrder | Provides the sequential order of charges for the transactional activity tier arrangement and references the element Order, which is required. |
| Service Charge Relationship Information | SerChgRelInfoRec_CType | Describes the behavior for customer relationships-based service charging. The
root level of the complex encompasses two arrays, Service Charge Level Array,
SerChgLvlArray_AType, and Service Level Relationship Array,
SerChgLvlRelArray_AType. |
| Service Charge Level Relationship Array | SerChgLvlRelArray_AType | Allows the consumer to submit any number of service provider recognized account relationships to consider for service charge level pricing. |
| Service Charge Level Information Record Array | SerChgLvlInfoRec_AType | Provides a grouping logic to create qualifications criteria. |
| Service Charge Level Order | SerChgLvlOrder | Provided to give an order to the test scenarios. This element is required. |
| Service Charge Level Application Amount Array | SerChgLvlAppAmtArray_AType | Used for test scenarios involving amount. This array defines the test scenarios
based on threshold amounts. It provides the required Service Charge Level Application
Order element, SerChgLvlAppOrder, which gives an order to the
application qualification scenarios. The Service Charge Level Application Detail
Array, SerChgLvlAppDetArray_AType, provides the specific applications
along with the balance calculation type for qualification consideration. |
| Service Charge Level Application Count Array | SerChgLvlAppCntArray_AType | Used for test scenarios involving count. This array provides the required Service
Charge Level Application Order element, SerChgLvlAppOrder,
which gives the order to the application qualification scenarios. The Service Charge
Level Application Detail Array, SerChgLvlAppDetArray_AType, provides
the specific applications. The balance calculation type for count qualifications is
ignored. |
Account Product Override Addition Business Case
The consumer is attempting to add an account product override in this business case.
The consumer sends the
AcctProdOvrrdAddRq_MType message to the Service Provider
with the following values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
AccountId | AcctId | 0002235555550015 |
AcctType | D | |
AcctProdOvrrdInfoRec | ||
TrnActTierInfoArray | ||
TrnAcctTierInfoRec | TierTrnActType | All |
TierChgAmt | .12 | |
TierTolrXsCnt | 20 |
The Service Provider returns AcctProdOvrrdAddRs_MType
containing the element RsStat with a value of Success.
AcctProdOvrrdAddRq_MType
AcctProdOvrrdAddRq_MType is a
message MType element.
Contains:
AccountId_CTypeAcctProdOvrrdInfoRec_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CType
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
AcctProdOvrrdInfoRec_CType
AcctProdOvrrdInfoRec_CType is a
complex CType element.
Contains:
EFTChgInfoArray_ATypeFDICInsurInfoRec_CTypeODInfoRec_CTypeProdBaseInfoRec_CTypeRedSerChgInfoRec_CTypeSerChgRelInfoRec_CTypeSerChgTierInfoArray_ATypeTrnActTierInfoArray_ATypeXferInfoRec_CTypeXsDrChgInfoArray_AType
EFTChgInfoArray_AType
EFTChgInfoArray_AType is an array
AType element. This is an array of charges for EFT
activity.
Contains:
EFTChgInfoRec_CType
EFTChgInfoRec_CType
EFTChgInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this message.
- EFTChgAmt
- The amount of charge for EFT type transactions.
- EFTChgPctRed
- The percentage that a service charge is reduced based on EFT transaction activity.
- EFTTrnActType
- The activity type of the EFT transaction. Canonical values are:
- ACH
- All
- Forn
- OnUs
- EFTTrnType
- The type of EFT transaction. Canonical values are:
- Cr
- Dr
- EFTWavTolrCnt
- The tolerance number of EFT transactions that result in the waiving of EFT charges.
FDICInsurInfoRec_CType
FDICInsurInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- FDICInsurChgCalcType
- The balance to use for FDIC charge calculations. Canonical values
are:
- AvgLdger
- Col
- Ldgr
- MinLdgr
- FDICInsurChgRate
- The rate to charge an account for FDIC insurance charges.
ODInfoRec_CType
ODInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ChgODFeeBal
- The threshold balance of an account before charging an account for maintaining a negative balance position.
- ODChgCalcType
- The balance to use for overdraft accrual calculations. Canonical
values are:
- Col
- Ldgr
- ODIdxNum
- Overdraft index number charged to accounts that are in an overdraft state.
ProdBaseInfoRec_CType
ProdBaseInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- SerChgAmt
- The amount of service charge assessed to an account.
- TrnHistRtnDays
- The number of days an account should retain transactional history.
- TrnHistRtnDaysType
- The type of retention days for transactional data behavior.
Canonical values are:
- Bus
- Cal
- ZeroBalAllwDays
- The number of days an account can maintain a zero balance without closing.
RedSerChgInfoRec_CType
RedSerChgInfoRec_CType is a complex
CType element.
Contains:
RedSerChgMthdArray_AType
Simple Elements
The following simple elements are contained within this complex.
- MinSerChgRedAmt
- The minimum amount a service charge can be reduced.
- SerChgTolrAmt
- The tolerance that triggers the behavior to waive the service charge when it falls below a predetermined amount.
- SerChgWavDrType
- The service charge is waived if the account has no debit
activity. Canonical values are:
- false
- true
- SerChgWavTrnType
- The service charge is waived if the account has no activity.
Canonical values are:
- false
- true
RedSerChgMthdArray_AType
RedSerChgMthdArray_AType is an
array AType element. This is an array of methods used to
reduce service charge amounts.
Contains:
RedSerChgMthdInfoRec_CType
RedSerChgMthdInfoRec_CType
RedSerChgMthdInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- RedSerChgAmt
- The service charge reduction amount.
- RedSerChgCalcType
- The balance to use for service charge reduction calculations.
Canonical values are:
- AvgCol
- AvgLdgr
- Ldgr
- MinLdgr
- RedSerChgIdxNum
- The reduced service charge index number that is used to calculate the amount to reduce the service charge amount.
- RedSerChgIncrAmt
- The incremental amount to use for service charge reduction calculations.
- RedSerChgMinBal
- The minimum balance amount maintained by an account to be considered for service charge reductions.
- RedSerChgMthdType
- The method to be used for service charge reductions. Canonical
values are:
- Amt
- Rate
- RedSerChgResrvPct
- The percentage to be used to reserve the balance amount prior to any service charge reduction behavioral calculations.
SerChgRelInfoRec_CType
SerChgRelInfoRec_CType is a complex
CType element.
Contains:
SerChgLvlArray_ATypeSerChgLvlRelArray_AType
Simple Elements
The following simple elements are contained within this complex.
- RedSerChgAmt
- The service charge reduction amount.
- RedSerChgMthdType
- The method to be used for service charge reductions. Canonical
values are:
- Amt
- Rate
- RedSerChgPct
- The percentage to be used for any service charge reduction behavioral calculations.
- SerChgLvlIncClub
- Include club accounts for relationship level service charging.
Canonical values are:
- false
- true
- SerChgLvlLgclOprnd
- The logical operand that determines if all the service charge
level relationships should be used in accessing qualifications for waiving
service charges. Canonical values are:
- And
- Or
- WavSerChgType
- The type values that determine the behavior for waiving a
service charge. Canonical values are:
- false
- true
SerChgLvlArray_AType
SerChgLvlArray_AType is an array
AType element. This is an array of levels with
qualifications for account relationship service charges.
Contains:
SerChgLvlInfoRec_CType
SerChgLvlInfoRec_CType
SerChgLvlInfoRec_CType is a complex
CType element.
Contains:
SerChgLvlAppAmtArray_ATypeSerChgLvlAppCntArray_AType
Simple Elements
The following simple elements are contained within this complex.
- SerChgLvlLgclOprnd
- The logical operand that determines if all the service charge
level relationships should be used in accessing qualifications for waiving
service charges. Canonical values are:
- And
- Or
- SerChgLvlOrder
- The order for service charge level relationships in accessing qualifications for waiving service charges.
SerChgLvlAppAmtArray_AType
SerChgLvlAppAmtArray_AType is an
array AType element. This is an array of applications used
to determine balance qualifications for waiving service charges.
Contains:
SerChgLvlAppAmtInfoRec_CType
SerChgLvlAppAmtInfoRec_CType
SerChgLvlAppAmtInfoRec_CType is a
complex CType element.
Contains:
SerChgLvlAppDetArray_AType
Simple Elements
The following simple elements are contained within this complex.
- SerChgLvlAlgSymb
- The algebraic symbol for the total of application balances.
Canonical values are:
- EQ
- GE
- GT
- LE
- LT
- NE
- SerChgLvlAppOrder
- The application order for service charge level relationships in accessing qualifications for waiving service charges.
- SerChgLvlTolrAmt
- The tolerance that triggers the behavior to waive the service charge when it falls below this amount for service charge levels.
SerChgLvlAppDetArray_AType
SerChgLvlAppDetArray_AType is an
array AType element. This is an array of detail
applications used to determine balance qualifications for waiving service
charges.
Contains
SerChgLvlAppDetInfoRec_CType
SerChgLvlAppDetInfoRec_CType
SerChgLvlAppDetInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- SerChgLvlApp
- The application for service charge level relationships in
accessing qualifications for waiving service charges. Canonical values
are:
- Dep
- Ln
- ODProt
- Savings
- TimeDep
- SerChgLvlCalcType
- The balance to use for service charge application level
calculations. Canonical values are:
- AvgCol
- AvgLdgr
- Ldgr
- MinLdgr
SerChgLvlAppCntArray_AType
SerChgLvlAppCntArray_AType is an
array AType element. This is an array of applications used
to determine count qualifications for waiving service charges.
Contains:
SerChgLvlAppCntInfoRec_CType
SerChgLvlAppCntInfoRec_CType
SerChgLvlAppCntInfoRec_CType is a
complex CType element.
Contains:
SerChgLvlAppDetArray_AType
Simple Elements
The following simple elements are contained within this complex.
- SerChgLvlAlgSymb
- The algebraic symbol for the total of application balances.
Canonical values are:
- EQ
- GE
- GT
- LE
- LT
- NE
- SerChgLvlAppOrder
- The application order for service charge level relationships in accessing qualifications for waiving service charges.
- SerChgLvlTolrCnt
- The tolerance that triggers the behavior to waive the service charge when it falls below this count for service charge levels.
SerChgLvlAppDetArray_AType
SerChgLvlAppDetArray_AType is an
array AType element. This is an array of detail
applications used to determine balance qualifications for waiving service
charges.
Contains
SerChgLvlAppDetInfoRec_CType
SerChgLvlAppDetInfoRec_CType
SerChgLvlAppDetInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- SerChgLvlApp
- The application for service charge level relationships in
accessing qualifications for waiving service charges. Canonical values
are:
- Dep
- Ln
- ODProt
- Savings
- TimeDep
- SerChgLvlCalcType
- The balance to use for service charge application level
calculations. Canonical values are:
- AvgCol
- AvgLdgr
- Ldgr
- MinLdgr
SerChgLvlRelArray_AType
SerChgLvlRelArray_AType is an array
AType element. This is an array of account relationships
that is considered for account override service charges.
Contains:
SerChgLvlRelInfoRec_CType
SerChgLvlRelInfoRec_CType
SerChgLvlRelInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AcctRelCode
- The code that describes the relationship a customer has to an account.
SerChgTierInfoArray_AType
SerChgTierInfoArray_AType is an
array AType element. This is an array of tier service
charges.
Contains:
SerChgTierInfoRec_CType
SerChgTierInfoRec_CType
SerChgTierInfoRec_CType is a
complex CType element.
Contains:
SerChgTierBalInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
SerChgTierBalInfoArray_AType
SerChgTierBalInfoArray_AType is an
array AType element. This is an array of balances for tier
service charges.
Contains:
SerChgTierBalInfoRec_CType
SerChgTierBalInfoRec_CType
SerChgTierBalInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- SerChgLvlAlgSymb
- The algebraic symbol for the total of application balances.
Canonical values are:
- EQ
- GE
- GT
- LE
- LT
- NE
- TierBalAmt
- The balance amount for a specific tier to determine tier charge qualifications.
- TierChgCalcType
- The balance to use for tier charge calculations. Canonical values
are:
- AvgCol
- AvgLdg
- Ldgr
- MinLdgr
- TierChgOrder
- The sequential order of charges in a tier charge arrangement.
TrnActTierInfoArray_AType
TranActTierInfoArray_AType is an
array AType element. This is an array of tier charges based
on transactional activity.
Contains:
TrnActTierInfoRec_CType
TrnActTierInfoRec_CType
TrnActTierInfoRec_CType is a
complex CType element.
Contains:
TierActBalInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- TierChgAmt
- The amount of a service charge for a specific tier assessed to an account.
- TierTolrXsCnt
- The tolerance number of transactions that results in the charging of transaction item charges.
- TierTrnActType
- The transactional type of activity for tier charges. Canonical
values are:
- All
- Cash
- Forn
- Local
- OnUs
- TierTrnType
- The transactional type of activity for tier charges. Canonical
values are:
- Cr
- Dr
- All
TierActBalInfoArray_AType
TierActBalInfoArray_AType is an array AType element. This is an array of balances for transactional activity tier
charges.
Contains:
TierActBalInfoRec_CType
TierActBalInfoRec_CType
TierActBalInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- SerChgLvlAlgSymb
- The algebraic symbol for the total of application balances.
Canonical values are:
- EQ
- GE
- GT
- LE
- LT
- NE
- TierBalAmt
- The balance amount for a specific tier to determine tier charge qualifications.
- TierChgCalcType
- The balance to use for tier charge calculations. Canonical values
are:
- AvgCol
- AvgLdg
- Ldgr
- MinLdgr
- TierChgOrder
- The sequential order of charges in a tier charge arrangement.
XferInfoRec_CType
XsDrChgInfoArray_AType
XsDrChgInfoArray_AType is an array AType element. This is an array of charges for excess debit activity.
Contains:
XsDrChgInfoRec_CType
XsDrChgInfoRec_CType
XsDrChgInfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- XsDrChgAmt
- The amount of charge for excess debit transactions.
- XsDrChgMthd
- The behavioral method for charging accounts excess debit charges.
Canonical values are:
- Dly
- false
- Stmt
- true
- XsDrChgWav
- The excess debit should be charged regardless of other account
settings. The canonical values are:
- Chg
- NA
- Wav
- XsDrTrnType
- The type of EFT transaction. Canonical values are:
- Any
- MMDAOnly
- MMDATP
- XsDrWavTolrCnt
- The tolerance number of debit transactions that results in the waiving of excess debit charges.
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.
AcctProdOvrrdAddRs_MType
AcctProdOvrrdAddRs_MType is a
message MType element.
Contains:
Custom_CTypeMsgRsHdr_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_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.