EFT Card Modification
EFT Card Modification
EFT Card Modification is a jXchange service designed to enable a consumer to deactivate an EFT card, activate an EFT card, and any other Service Provider accepted status changes. It also allows the Third Party Consumer to modify accounts related to a card.
Message Flow
In jXchange, the EFT Card Modification
service uses a typical exchange of MType messages to modify the
activation status of an EFT card or the accounts related to the card on a
Service Provider.
Primary Request
The Third Party Consumer forwards the
EFTCardModRq_MType
message to the Service Provider. The message contains EFTCardNum and EFTCardSufxNum.
Primary Response
The Service Provider returns the
EFTCardModRs_MType
message to the Third Party Consumer. The message contains RsStat, which states if the
modification was successful.
EFT Card Modification Behavior
The EFTCardNum is a required
element for this service.
The delivery with Dlt set to True conveys to the Service
Provider to remove the card record. However, the Service Provider reserves
the right to allow the record to exist and the delete element conveys the
change to a closed/delete status.
A specific EFT card account identification can be
removed utilizing the ~JHANULL~ attribute behavior.
The Service Provider may default a new EFT card primary account when the primary EFT card account identification is being removed.
CardStatRsnType
This element is a closed
enumerated type. The canonical values are provided by Industry Standard
Organization (ISO) 8583. This is a required element for the
EFTCardModRec_CType complex. There is no default value.
The element's canonical values are not inclusive of all of the ISO-8583
message codes, but are to those specific to the hot card process. The
canonical values are:
- 05: Do Not Honor
- 33: Expired Card, pick up
- 34: Suspected fraud, pick up
- 41: Lost card, pick up
- 43: Stolen card, pick up
- 59: Suspected fraud
CardStatRsnMsg
This element is not intended to duplicate the actual representation of the ISO-8583. It is intended to allow a person to read a string value for the card status modification change.
CrtEftCardAlertMsg
This element is a closed enumerated type. The default value is false. The canonical value true tells the Service Provider to create their application's standard alert message for the modification request.
OrderEFTCardRepl
This element is a closed enumerated type. The default value is false. The canonical value true tells the Service Provider to order a new EFT card and issue a new EFT card number. The replacement card duplicates all of the necessary Service Provider's database elements as required to create an EFT card database record. The new EFT card number will be returned in the response message only if a replacement card has been requested.
EFTCardModRq_MType
EFTCardModRq_MType is a message
MType element.
Contains:
Custom_CTypeEFTCardModRec_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
- Dlt
The delete element. Canonical values are:
- false
- true
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardPINOffSetId
- The EFT card PIN offset identification.
- EFTCardSufxNum
- The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
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.
EFTCardModRec_CType
EFTCardModRec_CType is a complex
CType element.
Contains:
Custom_CTypeEFTCardAcctIdArray_ATypeEFTCardBlkTrnArray_ATypeEFTCardCntryArray_ATypeEFTCardMailAddrInfo_CTypeEFTCardTrvInfo_CTypeEmailArray_ATypeMerNotfOptInfoArray_ATypePhoneArray_ATypeRmk_ATypeSvcPrvdInforeferencesEFTCardModRec_ETypeUserDefInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- EFTSwchActType
The action that is taken in regards to the EFT switch relationship. Canonical values are:
- ForceAdd
- ForceBatch
- ForceUpd
- AFTDrPostLmtAmt
- The debit limit amount for automatic funding withdrawal transactions.
- AFTDrTempPostLmtAmt
- The debit limit amount for automatic withdrawal transactions on a temporary basis.
- AllowFornTrnType
- Are foreign transactions allowed for the card? Canonical values
are:
- false
- true
- AllowGlobalMain
- Is the card allowed to be maintained with installation global
changes? Canonical values are:
- false
- true
- AllowMaxPIN
- The number of allowable PIN attempts at a given ATM.
- ATMCrPostLmtAmt
- The ATM credit transaction amount limit amount to be posted to an account.
- ATMCrPostLmt
- Does the ATM credit transaction amount have a limit of the amount to
be posted to an account? Canonical values are:
- false
- true
- ATMCrPostPct
- The percentage amount of ATM credit transactions to be posted to the account.
- ATMCrPostType
- Answers the question: Should ATM credit transactions be posted to
the account? Canonical values are:
- false
- true
- ATMDrPostLmtAmt
- The debit limit amount for ATM withdrawal transactions.
- ATMDrTempPostEndDt
- The date that designates the ending point for date selections.
- ATMDrTempPostLmtAmt
- The debit limit amount for ATM withdrawal transactions on a temporary basis.
- ATMDrTempPostStartDt
- The date that designates the starting point for date selections.
- CardRushMthdCode
- The code that identifies the type of rush method for card delivery.
- CardRushOpt
Option for rushing a payment to a payee. Canonical values are:
- 2ndDay - Second Day
- 2ndDayEc - Second Day Economy
- 3rdDay - Third Day
- Ovrngt - Overnight
- Std - Standard
- CardStatRsnMsg
- An EFT card reason as understood by the clerk.
- CardStatRsnType
- An EFT card reason code change in accordance with ISO 8583
established reasons. This is a required element when the status of the card is
modified to hot. Canonical values are:
- 05
- 33
- 34
- 41
- 43
- 59
- CrtEFTCardAlertMsg
- Answers the question: Should the EFT Card provider create a
standard alert message? Canonical values are:
- false
- true
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- EFTCardAcctNum
- The EFT card account number exclusive from the ISO number.
- EFTCardAltExpDt
- The expiration date.
- EFTCardCat
- A user-defined category given to an EFT card.
- EFTCardExpDt
- The expiration date given to an EFT card.
- EFTCardImgId
- An identifier given to an EFT card.
- EFTCardIssue
- Has the customer been issued an EFT card? Canonical values are:
- false
- true
- EFTCardLastIssueDt
- The EFT card's last issue date.
- EFTCardOrigIssueDt
- The EFT card's original issue date.
- EFTCardPINIssue
- Answers the question: Has the EFT card been issued a Personal
Identification Number (PIN)? Canonical values are:
- false
- true
- EFTCardPINOffSetId
- The EFT card PIN offset identification.
- EFTCardProdCode
- The code that identifies the type details of an EFT card.
- EFTCardReOrderFee
- The fee amount to be assessed for EFT card reorders.
- EFTCardStat
- The status of an issued EFT card. Canonical values are:
- Act
- Cls
- CardLmtExist
- Del
- DepOnly
- Exp
- HotCard
- Iss
- ManActReq
- OrderCard
- OrderInProc
- PINMail
- PINXsTries
- ReOrderCard
- ReOrderDeny
- WarmCard
Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new element for EFT statuses is EFTCardStatType, in which the status values are represented by closed canonical values. - EFTCardStatType
- The status of an issued EFT card. Canonical values are:
- Act
- CardLmtExist
- Cls
- Del
- DepOnly
- Exp
- HotCard
- InstantIss
- InstantIssMail
- Iss
- ManActReq
- OrderCard
- OrderInProc
- PINMail
- PINXsTries
- ReOrderCard
- ReOrderDeny
- WarmCard
- EFTCardStyleId
- The EFT card manufacturer's card style identification.
- EFTCardTelePINId
- The telephone Personal Identification Number assigned to a new card for card holder PIN selection.
- EFTCardTempExpDt
- The expiration date.
- EFTSCChgWav
- The EFT card service charges behavior. Canonical values are:
- Chg
- NA
- Wav
- EFTSCCode
- The code that designates the behavior for charging for EFT activity.
- EFTTrnLmtCnt
- The number of EFT transactions that are limited for an EFT card.
- EmbosName
- The name that is embossed on the EFT card.
- EndDt
- The date that designates the ending point for date selections.
- ExpDt
- The expiration date.
- ImgDepMemoLmtType
- Answers the question: Do deposits captured with an image have any
limits for memo posting? Canonical values are:
- false
- true
- ImgDepMemoPostDlyMax
- Deposits captured with an image memo-post daily dollar limit amount.
- ImgDepMemoPostPct
- Deposits captured with an image memo-post limit percentage.
- ImgDepMemoPostType
- Answers the question: Should deposits captured with an image be
memo posted? Canonical values are:
- false
- true
- OrderEFTCardRepl
- Answers the question: Should an EFT card replacement be reordered?
Canonical values are:
- false
- true
- POSDrPostLmtAmt
- The debit limit amount for POS withdrawal transactions.
- POSDrTempPostEndDt
- The date that designates the ending point for date selections.
- POSDrTempPostLmtAmt
- The debit limit amount for POS withdrawal transactions on a temporary basis.
- POSDrTempPostStartDt
- The date that designates the starting point for date selections.
- RushOpt
- Option for rushing a payment to a payee. Canonical values are:
- 2ndDay - Second Day
- 2ndDayEc - Second Day Economy
- 3rdDay - Third Day
- Ovrngt - Overnight
- Std - Standard
- SecdEmbosName
- The secondary name that could be embossed on the EFT card.
- StartDt
- The date that designates the starting point for date selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardAcctIdArray_AType
EFTCardAcctIdArray_AType is an array AType element. This is an array of the accounts that are part of an EFT card
account.
Contains:
EFTCardAcctIdInfo_CType
EFTCardAcctIdInfo_CType
EFTCardAcctIdInfo_CType is a
complex CType element. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- AliasAcctName
- An alias name provided to an account that is often used for GUI representation that is understandable to an end consumer.
- EFTCardAcctId
- The numbers or characters that identify an EFT card account record.
- EFTCardAcctType
- The numbers or characters that categorize the EFT Card Account ID.
- EFTCardFundAcctType
- The funding account indicator. Canonical values are:
- true
- false
- EFTCardPrimAcct
- References the account identification that has the primary
relationship to the EFT card account. Canonical values are:
- false
- true
EFTBlkTrnTypeArray_AType
EFTBlkTrnTypeArray_AType is an array
AType element. This is an array of EFT transaction types subject to
blocking.
Contains:
EFTBlkTrnTypeInfo_CType
EFTCardBlkTrnInfo_CType
EFTCardBlkTrnInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EFTBlkTrnCode
- The transaction code that defines the behavior for block EFT transactions.
- EFTOvrrdBlkTrnEnd0Dt
- The date that designates the ending point for date selections.
- EFTOvrrdBlkTrnStartDt
- The date that designates the starting point for date selections.
EFTCardCntryArray_AType
EFTCardCntryArray_AType is an array AType element. This is an array of countries that
impacts EFT transaction activity.
Contains:
EFTCardCntryInfo_CType
EFTCardCntryInfo_CType
EFTCardCntryInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- CntryExcStartDt
- The date that designates the starting point for date selections.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- EFTCardCntryExcType
- The exception type for a specific country that impacts EFT card
transaction processing. Canonical values are:
- Acpt
- Blk
- ExpDt
- The expiration date.
EFTCardMailAddrInfo_CType
EFTCardMailAddrInfo_CType is a complex
CType element.
Contains:
Addr_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- EFTCardPrvdAcctType
- The number or character that categorizes the AcctId.
- EFTCardPrvdId
- The number or character that identifies an account record.
- ExpDt
- The expiration date.
Addr_CType
Addr_CType is a complex
CType element containing address information. This element
is optional.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP 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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardTrvInfo_CType
EFTCardTrvInfo_CType is a complex
CType element.
Contains:
TrvPhoneArrayreferencesPhoneArray_AType
Simple Elements
The following simple elements are contained within this complex.
- CardHolderConFraudType
- Answers the question: Should the cardholder be contacted if there is
suspected fraud activity? Canonical values are:
- false
- true
- TrvEndDt
- The date that designates the ending point for date selections.
- TrvNotType
- The type of travel notification. Canonical values are:
- Trv
- TrvVac
- Vac
- TrvRmk
- Application or user remarks free-form text.
- TrvStartDt
- The date that designates the starting point for date selections.
- VacEndDt
- The date that designates the ending point for date selections.
- VacRmk
- Application or user remarks free-form text.
- VacStartDt
- The date that designates the starting point for date selections.
TrvPhoneArray
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.
TrvPhoneArray 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
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.
MerNotfOptInfoArray_AType
MerNotfOptInfoArray_AType is an array AType element. This is an array of
opt-out codes for merchant notification.
Contains:
MerNotfOptInfoRec_CType
MerNotfOptInfoRec_CType
MerNotfOptInfoRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- EFTMerId
- The identification given to EFT card merchant transaction processors.
- MerNotfOptCode
The code that describes the opt in/out for merchant notification. Canonical values are:
- false
- true
The default value is false.
- MerNotfOptDesc
- The description of the code that describes the opt in/out for merchant notification.
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.
Rmk_AType
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
Contains:
RmkInfo_CType
RmkInfo_CType
RmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Rmk
- Application or user remarks free-form text.
SvcPrvdInfo
SvcPrvdInfo is available only for JHA
Consumers.
SvcPrvdInfo references EFTCardModRec EType.
EFTCardModRec_EType
EFTCardModRec_EType is an extended
EType element.
Contains:
JHAConsumerreferencesEFTCardModRec_JIS_CType
JHAConsumer
EFTCardModRec_JIS_CType is complex
CType element.
JHAConsumer references EFTCardModRec_JIS_CType.
Simple Elements
The following simple elements are contained within this complex.
- EFTCardPINOffSetId
- The EFT card PIN offset identification.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
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.
EFTCardModRs_MType
EFTCardModRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardSufxNum
- The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
- 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.