EFT Card Inquiry
EFT Card Inquiry
EFT Card Inquiry is a jXchange service designed to allow the consumer to inquire on the EFT card data.
Message Flow
In jXchange, the EFT Card Inquiry service uses a typical exchange of MType messages to inquire on the
EFT card data to a service provider.
Primary Request
The consumer forwards the EFTCardInqRq_MType message to the service provider. The message contains the
required EFTCardNum and optional
EFTCardSufxNum elements.
Primary Response
The service provider returns the EFTCardInqRs_MType message to the
consumer. The message contains EFTCardNum and
EFTCardSufxNum elements and the EFTCardInqRec_CType complex.
EFTCardInqRq_MType
EFTCardInqRq_MType is a message
MType element.
Contains:
Custom_CTypeIncXtendElemArray_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- 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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType is an array
AType element.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
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.
EFTCardInqRs_MType
EFTCardInqRs_MType is a message
MType element.
Contains:
Custom_CTypeEFTCardInqRec_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
- 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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardInqRec_CType
EFTCardInqRec_CType is a complex CType element.
Contains:
Addr_CTypeCustom_CTypeEFTCardAcctIdArray_ATypeEFTCardRejArray_ATypeEFTCardTrnArray_ATypeEmailArray_ATypeMerNotfOptInfoArray_ATypePhoneArray_ATypeRmk_ATypex_EFTCardBlkTrnArray_ATypex_EFTCardCntryArray_ATypex_EFTCardMailAddrInfo_CTypex_EFTCardTrvInfo_CTypex_UserDefInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AFTDrLmtUseAmt
- The debit limit amount for automatic funding withdrawal transactions used.
- AFTDrPostLmtAmt
- The debit limit amount for automatic funding withdrawal transactions.
- AFTDrTempPostLmtAmt
- The debit limit amount for automatic withdrawal transactions on a temporary basis.
- AllowDigitalInActType
- Defines if an inactive card is allowed digital wallet processes.
Canonical values are:
- true
- false
- AllowDigitalOnlyType
- Is the card only allowed for digital wallet processes? Canonical
values are:
- true
- false
- AllowFornTrnExpDt
- The foreign transaction allowable expiration date.
- 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.
- ATMCrPostAmt
- The total credit ATM posted amount of transactions on a given business day.
- 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
- ATMDrLmtUseAmt
- The debit limit amount for ATM withdrawal transactions used.
- 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.
- CardRushMthdDesc
- The description of 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
- 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
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- EFTCardAlertUsrId
- The user identification related to an EFT card alert.
- EFTCardAltExpDt
- The expiration date.
- EFTCardBINCode
- The code that identifies the type of BIN.
- EFTCardBINDesc
- The description of the code that identifies the type of BIN.
- EFTCardCat
- A user-defined category given to an EFT card.
- EFTCardChgWavAmt
- The number of EFT card charges that have been waived.
- EFTCardChgWavCnt
- The number of EFT card charges that have been waived.
- EFTCardCmprmType
- Answers the question: Has the EFT card been reported as being
compromised? Canonical values are:
- false
- true
- EFTCardExpDt
- The expiration date given to an EFT card.
- EFTCardImgDesc
- The free-format description as related to a card image.
- 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.
- EFTCardLmtCnt
- The number of times that an EFT card transaction limit was reached.
- 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.
- EFTCardProdDesc
- The description of the code that identifies the type details of an EFT card.
- EFTCardReadType
Defines the type of EFT card security read. Canonical values are:
- Chip
- Mag
- EFTCardReadType
Defines the type of EFT card security read. Canonical values are:
- Chip
- Mag
- EFTCardStatDesc
- The description of the status of an issued EFT card.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.
- 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.
- EFTHotCardTimeDt
- The date and time stamp when a card was changed to a status of Hot Card.
- 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.
- EFTSwchActType
The action that is taken in regards to the EFT switch relationship. Canonical values are:
- ForceAdd
- ForceBatch
- ForceUpd
- EFTTrnLmtCnt
- The number of EFT transactions that are limited for an EFT card.
- EFTTrnLmtUseCnt
- The number of EFT transactions that are limited for an EFT card used.
- 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
- ImgDepMemoPostAmt
- Deposits captured with an image memo-post amount.
- 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
- InvalidPINAttempts
- The number of invalid PIN attempts made in a business day.
- LastActDt
- The date of the last activity.
- LastEFTCardActDt
- The last EFT card activation date.
- LastMainDt
- The last maintenance date.
- LastStatDt
- The date the last time the status was changed.
- POSDrLmtUseAmt
- The debit limit amount for POS withdrawal transactions used.
- 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.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
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.
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
EFTCardRejArray_AType
EFTCardRejArray_AType is an array
AType element. This is an array of EFT card transactional
rejected activity.
Contains:
EFTCardRejInfo_CType
EFTCardRejInfo_CType
EFTCardRejInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EFTCardRejLTDTrnCnt
- The number of times a reject transactional activity occurred for an EFT card life-to-date.
- EFTCardTrnType
- The EFT card transactional activity type. Canonical values are:
- Dep
- DrCard
- Inq
- POS
- Wthdwl
- Xfer
EFTCardTrnArray_AType
EFTCardTrnArray_AType is an array AType element. This is an array of EFT card transactional activity.
Contains:
EFTCardTrnInfo_CType
EFTCardTrnInfo_CType
EFTCardTrnInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EFTCardLTDTrnAmt
- The amount of EFT card life-to-date transactions.
- EFTCardLTDTrnCnt
- The number of EFT card life-to-date transactions.
- EFTCardTrnCnt
- The EFT card transactional activity count.
- EFTCardTrnLocType
- The EFT card transactional activity location type. Canonical values
are:
- Forn
- Local
- EFTCardTrnType
- The EFT card transactional activity type. Canonical values are:
- Dep
- DrCard
- Inq
- POS
- Wthdwl
- Xfer
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.
x_EFTCardBlkTrnArray_AType
x_EFTCardBlkTrnArray_AType is an array
AType element. This is an
array of EFT transactions for the card processor to block.
Contains:
x_EFTCardBlkTrnInfo_CType
EFTCardBlkTrnInq service should be used to replace this array.x_EFTCardBlkTrnInfo_CType
x_EFTCardBlkTrnInfo_CType is a complex
CType element.
Contains:
EFTBlkMerIdArray_ATypeEFTBlkTrnTypeArray_ATypeEFTCardAcptPostalCodeArray_ATypeEFTCardAcptStateArray_ATypeEFTCardBlkTrnInfo_CTypeEFTCardPINEntryArray_ATypeEFTPseudoTrmlIdArray_AType
Simple Elements
The following simple elements are contained within this complex.
- EFTBlkPOSCondCode
- The code that conveys the POS card EFT blocking condition code.
- EFTBlkPOSCondDesc
- The description of the code that conveys the POS card EFT blocking condition code.
- EFTBlkTrnDesc
- The description of the transaction code that defines the behavior for block EFT transactions.
- EFTBlkTrnEndDt
- The date that designates the ending point for date selections.
- EFTBlkTrnExpType
- Answers the question: Has the EFT blocking transaction expired?
Canonical values are:
- false
- true
- EFTBlkTrnHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- EFTBlkTrnLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- EFTBlkTrnStartDt
- The date that designates the starting point for date selections.
- EFTCardAcptId
- The identification of the merchant/terminal of the acceptance of an EFT card transaction.
- EFTCardAcptName
- The name of the merchant/terminal of the acceptance of an EFT card transaction.
- EFTISOBlkId
- The ISO identifier given to a transaction blocking rule.
- EFTTrmlId
- The identification given to EFT card terminals.
EFTCardBlkTrnArray_AType
EFTCardBlkTrnArray_AType is an array
AType element. This is an array of EFT transactions that should be blocked by
the card processor.
Contains:
EFTCardBlkTrnInfo_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.
EFTPseudoTrmlIdArray_AType
EFTPseudoTrmlIdArray_AType is an array AType element. This is an array of EFT pseudo names
related to EFT terminal identifications.
Contains:
EFTPseudoTrmlIdInfo_CType
EFTPseudoTrmlIdInfo_CType
EFTPseudoTrmlIdInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- PseudoTrmlId
- The identification given to EFT card terminals.
EFTCardPINEntryArray_AType
EFTCardPINEntryArray_AType is an array AType element. This is an array of EFT card pin entry
methods.
Contains:
EFTCardPINEntryInfo_CType
EFTCardPINEntryInfo_CType
EFTCardPINEntryInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EFTCardPINEntryCode
- The code that describes the method that was utilized for EFT card PIN entry.
- EFTCardPINEntryDesc
- The description of the code that describes the method that was utilized for EFT card PIN entry.
EFTCardAcptStateArray_AType
EFTCardAcptStateArray_AType is an array
AType element. This is an array of EFT states where transactions are
accepted.
Contains:
EFTCardAcptStateInfo_CType
EFTCardAcptStateInfo_CType
EFTCardAcptStateInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EFTCardAcptState
- Corresponding abbreviation for the state.
EFTCardAcptPostalCodeArray_AType
EFTCardAcptPostalCodeArray_AType is an
array AType element. This is an array of EFT postal codes where transactions
are accepted.
Contains:
EFTCardAcptPostalCodeInfo_CType
EFTCardAcptPostalCodeInfo_CType
EFTCardAcptPostalCodeInfo_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- EFTCardAcptPostalCode
- The postal code or ZIP code.
EFTBlkMerIdArray_AType
EFTBlkMerIdArray_AType is an array
AType element. This is an array of EFT merchant identifications that is
blocked from transaction processing.
Contains:
EFTBlkMerIdInfo_CType
EFTBlkMerIdInfo_CType
EFTBlkMerIdInfo_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.
x_EFTCardCntryArray_AType
x_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.
x_EFTCardMailAddrInfo_CType
x_EFTCardMailAddrInfo_CType is a complex CType
element. This is the mailing address for EFT cards issuance.
Contains:
EFTCardMailAddrInfo_CType
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.
x_EFTCardTrvInfo_CType
x_EFTCardTrvInfo_CType is a complex
CType element.
Contains:
EFTCardTrvInfo_CType
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
x_UserDefInfoArray_AType
x_UserDefInfoArray_AType is an array AType element. This is an array of user defined 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.
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.