EFT Card Transaction History Search
EFT Card Transaction History Search
EFT Card Transaction History Search is a jXchange service designed to allow a consuming product to access EFTCard transaction history.
Message Flow
In jXchange, the EFT Card Transaction History Search service uses a typical exchange of
MType messages to allow a consuming product to access EFTCard transaction
history. This service allows the product to only display history associated with a card
without having to receive all account-related transaction history data. The message uses the
card number instead of the account number when making the request.
Primary Request
The consumer forwards the EFTCardTrnHistSrchRq_MType message to the
service provider. The message contains the following simple elements:
- EFTCardNum
- EFTCardSufxNum
- EndTimeDt
- StartTimeDt
Primary Response
The service provider returns the EFTCardTrnHistSrchRs_MType message to the
consumer. The message contains the following simple elements:
- EFTCardNum
- EFTCardSufxNum
- EndTimeDt
- StartTimeDt
EFT Card Transaction History Search Behavior
The EFT Card Transaction History Search (EFTCardTrnHistSrch) service
behavior is as follows.
The request call is made with the required element EFTCard number. The EFTCard Suffix Number is optional.
EFTCardTrnHistSrchRq_MType
EFTCardTrnHistSrchRq_MType is a message MType
element.
Contains:
Custom_CTypeSrchMsgRqHdr_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.
- EndTimeDt
- The date and time that designates the ending point for date/time selections.
- StartTimeDt
- The date and time that designates the starting point for date/time selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message 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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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 submitted message. A
financial institution entity uses the routing transit or ABA nine-digit number
assigned to financial institutions for the purpose of 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 uses a mutually
agreed upon identification that must contain at least one non-integer character.
When a record is directed to a specific financial institution within a holding
company, the institution routing identification is the specific financial
institution routing identification and not the holding company identification.
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.
EFTCardTrnHistSrchRs_MType
EFTCardTrnHistSrchRs_MType is a message MType
element.
Contains:
Custom_CTypeEFTCardTrnHistSrchRecArray_ATypeSrchMsgRsHdr_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.
- EndTimeDt
- The date and time that designates the ending point for date/time selections.
- StartTimeDt
- The date and time that designates the starting point for date/time selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardTrnHistSrchRecArray_AType
EFTCardTrnHistSrchRecArray_AType is an array AType
element. This is an array of responses for EFTCard transaction history search.
Contains:
EFTCardHistSrchRec_CType
EFTCardHistSrchRec_CType
EFTCardHistSrchRec_CType is a complex CType element.
Contains:
EFTDescArray_ATypeRealTimePostRec_CTypeRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- AddrVerifCode
- The code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifDesc
- The description of the code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifText
- Any textual values provided by the transaction initiator regarding the address verification.
- AppTrnGenr
- Answers the question: Did the EFT transaction application provider
generate a transaction? Canonical values are:
- false
- true
- ATMTrnSttlType
- Answers the question: Was the EFT transaction settled at the time
of the initiated transaction? Canonical values are:
- false
- true
- CashDistrType
- Answers the question: Was cash distributed/dispensed for the EFT
transaction? Canonical values are:
- false
- true
- EFTAtUsATMType
- Answers the question: Was the EFT transaction initiated by one of the
financial institution's ATM terminals? Canonical values are:
- false
- true
- EFTCardCapType
- What process was used to capture the EFT card data? Canonical values
are:
- BarCode
- CertMagRead
- ChipRead
- ElecMer
- FallbackMagRead
- Keyed
- MagRead
- NFCChipRead
- NFCMagRead
- OCR
- Trak
- UnCertChipRead
- EFTCardExpDt
- The expiration date given to an EFT card.
- 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.
- EFTCashTrnRqAmt
- The cash transaction amount requested by the card holder.
- EFTExcAmt
- The amount of the transaction that is not accepted and is considered an exception.
- EFTHostRecvTime
- The card switch settlement time of the transaction.
- EFTNtwkId
- The identification that defines the network for the original acquirer of the transaction.
- EFTOnUsTrnType
- Answers the question: Was the EFT transaction initiated by the
financial institution's account holder? Canonical values are:
- false
- true
- EFTPrvdApprvBalAmt
- The balance that was used by the EFT card processor for transaction approval when the application provider was not available.
- EFTPrvdApprvTrn
- Answers the question: Was the transaction approved by the EFT card
processor? Canonical values are:
- false
- true
- EFTSwchSeqId
- The identification given to the transaction by the card switch provider.
- EFTSwchSttlDt
- The card switch settlement date of the transaction.
- EFTSwchTrnDt
- The card switch date of the transaction.
- EFTSwchTrnTime
- The card switch time of the transaction.
- EFTTrnActIdType
- Describes the type of EFT transaction activity identification.
Canonical values are:
- ForcePost
- Rev
- Rq
- EFTTrnAmt
- The actual amount of the transaction accepted by the provider.
- EFTTrnAuthBalAmt
- The balance that was used for authorization of the EFT transaction.
- EFTTrnCode
- The code that defines the type of EFT transaction.
- EFTTrnCorrelId
- An identification provided by a network to correlate a pre-authorization with the EFT transaction.
- EFTTrnDesc
- The description of the code that defines the type of EFT transaction.
- EFTTrnDt
- The date of the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnRcptBalAmt
- The balance that was printed on the receipt for the EFT transaction.
- EFTTrnRqAmt
- The transaction amount requested by the card holder.
- EFTTrnRsTime
- The amount of time for a transaction response.
- EFTTrnSeqId
- The identification given to the transaction by the provider.
- EFTTrnStatDesc
- The description of the status of the EFT transaction.
- EFTTrnStatRmk
- Any additional free-form remarks regarding the status of the EFT transaction.
- EFTTrnStat
- The status of the EFT transaction.
- EFTTrnTime
- The time of the transaction.
- EFTXferToAcctId
- The recipient account identification of an EFT transfer transaction.
- EFTXferToAcctType
- The numbers or characters that categorize the
EFTXferToAcctId. - ExcRsnCode
- The code that describes the reason for the exception.
- ExcRsnDesc
- The description of the code that describes the reason for the exception.
- MerName
- The name of the merchant that processed the POS transaction.
- MerPartAuth
- Answers the question: Does the POS merchant support/accept partial
authorizations? Canonical values are:
- false
- true
- PreAuthExpDt
- The expiration date for the pre-authorized transaction.
- PreAuthRemDays
- The number of days remaining for the pre-authorized transaction.
- RecurTrnType
- Identifies a transaction as recurring. Canonical values are:
- false
- true
- Secure3DValidRsltCode
- 3D Secure (3DS) is an authentication method that provides an additional layer of authentication for credit card transactions, protecting against fraudulent actors.
- SerChgAmt
- The amount of service charge assessed to an account.
- StdIndustCode
- The standard industry code.
- StdIndustDesc
- The standard industry code description.
- SurChgAmt
- The amount of the transaction that is part of the charges for the transactional activity.
- SwchTrnType
- Answers the question: Was the EFT transaction processed through
a switch network? Canonical values are:
- false
- true
- TrnSaveUpAmt
- The amount that was applied to Save Up value for a specific transaction.
- TrnSttlDt
- The date a transaction was settled.
- TrnSttlTime
- The time a transaction was settled.
EFTDescArray_AType
EFTDescArray_AType is an array
AType element.
Contains:
EftDescInfo_CType
EftDescInfo_CType
EftDescInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EftDesc
- A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.
RealTimePostRec_CType
RealTimePostRec_CType is a complex CType element.
Contains:
RealTimeErrActArray_AType.Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ActState
Identifies the real-time posting activity state. Canonical values are:
- InProc
- Posted
- PostInProc
- ProcStat
- Identifies the processing status as related to real-time posting.
Canonical values are:
- Proc
- Excl
- Rej
- SvcChgOnly
- TrnRcptId
- The receipt provided for a successful transaction entry.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RealTimeErrActArray_AType
RealTimeErrActArray_AType is an array AType element.
It is an array of errors related to real time posting.
Contains:
RealTimeErrActRec_CType
RealTimeErrActRec_CType
RealTimeErrActRec_CType is a complex CType
element.
Contains:
Custom_CType
- 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.
- ErrHaltType
Was the process halted due to an error? Canonical values are:
- true
- false
- ErrLoc
- The Soap Header Fault error location. This is typically the program that generated the error condition.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex
CType element. It searches
specific message response headers.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned.
Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be
larger than
MaxRec.
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 submitted message. A
financial institution entity uses the routing transit or ABA nine-digit number
assigned to financial institutions for the purpose of 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 uses a mutually
agreed upon identification that must contain at least one non-integer character.
When a record is directed to a specific financial institution within a holding
company, the institution routing identification is the specific financial
institution routing identification and not the holding company identification.
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.
Topics in this section
- Have a how-to question? Seeing a weird error? Get help on our collaborative Discourse page.
- Register for the Developer Office Hours where we answer technical Q&A, in real time, from the audience.