Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Credit Card Transaction History Search

Enterprise SOAP API > API by Reference > Card Services > Credit Card Transaction History Search

Credit Card Transaction History Search

Message Flow

Credit Card Transaction History Search is a jXchange service designed to provide consumers the ability to inquire on the transaction history for a credit card.

In jXchange, the Credit Card Transaction History Search service uses a typical exchange of MType message to provide consumers the ability to inquire on the transaction history for a credit card.

Primary Request

The consumer forwards the CrCardTrnHistSrchRq_MType message to the service provider. The message contains the following simple elements:

  • CrCardAcctId
  • EndDt
  • IncCardStmtTrnType
  • StartDt

Primary Response

The service provider returns the CrCardTrnHistSrchRs_MType message to the consumer. The message contains the following simple elements:

  • CrCardAcctId
  • EndDt
  • IncCardStmtTrnType
  • StartDt

Credit Card Transaction History Search Behavior

The Credit Card Transaction Search root request message (CrCardTrnHistSrchRq_MType) requires a valid Credit Card Account Identification (CrCardAcctId). The root request optionally includes the Include Card Statement Transaction Type (IncCardStmtTrnType), Start Date (StartDt), and End Date (EndDt).

The Include Card Statement Transaction Type (IncCardStmtTrnType) has the canonical values false and true. The value IncCardStmtTrnType=true conveys to the service provider to include transactions that have been reported on a statement.

The Transaction History Search Start Date (StartDt) and Transaction History End Date (EndDate) are compared to element EFT Transaction Date (EFTTrnDt). The EFT Transaction Authorization Date (EFTTrnAuthDt) is used for the compare when the EFT Transaction Date (EFTTrnDt) is absent/null.

A consumer request with a Start Date (StartDt) but without an End Date (EndDate) returns all the qualified Transaction History records with a date equal to and greater than the EFT Transaction Date (EFTTrnDt) or EFT Transaction Authorization Date (EFTTrnAuthDt).

A consumer request with an End Date (EndDt) but without a Start Date (StartDt) returns all the qualified Transaction History records with a date equal to and less than the EFT Transaction Date (EFTTrnDt) or EFT Transaction Authorization Date (EFTTrnAuthDt).

A consumer request with a Start Date (StartDt) and an End Date (EndDt) returns all the qualified Transaction History records with a date equal to and greater than the EFT Transaction Date (EFTTrnDt) or EFT Transaction Authorization Date (EFTTrnAuthDt) and a date equal to and less than the EFT Transaction Date (EFTTrnDt) or EFT Transaction Authorization Date (EFTTrnAuthDt).

The Credit Card Transaction Search root response message (CrCardTrnHistSrchRs_MType) echoes back the request element and Credit Card Transaction History Search Array (CrCardTrnHistSrchArray_AType) ,which encapsulates the Credit Card Transaction History Search Record complex (CrCardTrnHistSrchRec_CType).

The Credit Card Transaction History Search Record complex (CrCardTrnHistSrchRec_CType) encapsulates the following:

  • Credit Card Authorization Identifier (CrCardAuthId)
  • Credit Card Transaction Status Type (CrCardTrnStatType)
  • EFT Card Capture Type (EFTCardCapType)
  • EFT Description (EFTDesc)
  • EFT Merchant Identifier (EFTMerId)
  • EFT Merchant State Code (EFTMerStateCode)
  • EFT Transaction Amount (EFTTrnAmt)
  • EFT Transaction Authorization Amount (EFTTrnAuthAmt)
  • EFT Transaction Authorization Date (EFTTrnAuthDt)
  • EFT Transaction Code (EFTTrnCode)
  • EFT Transaction Date (EFTTrnDt)
  • EFT Transaction Description (EFTTrnDesc)
  • EFT Transaction Processing Date (EFTTrnProcDt)
  • Exception Reason Code (ExcRsnCode)
  • Exception Reason Description (ExcRsnDesc)
  • Merchant Business Category Description (MerBusCatDesc)
  • Merchant City (MerCity)
  • Merchant Name (MerName)
  • Merchant Postal Code (MerPostalCode)
  • Transaction Reference (TrnRef)

CrCardTrnHistSrchRq_MType

CrCardTrnHistSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CrCardAcctId
The number or character that identifies an account record.
EndDt
The date that designates the ending point for date selections.
IncCardStmtTrnType
Answers the question: Include the card transactions that have been reported on a statement? Canonical values are:
  • false
  • true
StartDt
The date that designates the starting point for date 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_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

CrCardTrnHistSrchRs_MType

CrCardTrnHistSrchRs_MType is a message MType element.

Contains:

  • CrCardTrnHistSrchArray_AType
  • Custom_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

CrCardAcctId
The number or character that identifies an account record.
EndDt
The date that designates the ending point for date selections.
IncCardStmtTrnType
Answers the question: Include the card transactions that have been reported on a statement? Canonical values are:
  • false
  • true
StartDt
The date that designates the starting point for date selections.

CrCardTrnHistSrchArray_AType

CrCardTrnHistSrchArray_AType is an array AType element. This is an array of responses for account history and credit card transaction history search.

Contains:

  • CrCardTrnHistSrchRec_CType

CrCardTrnHistSrchRec_CType

CrCardTrnHistSrchRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AliasCrCardId
The number or character that identifies an account record.
CrCardAuthId
The credit card identifier provided for transaction authorization.
CrCardTrnStatType
The status of the credit card transactions. Canonical values are:
  • Auth
  • Post (default)
EFTCardCapType
Answers the question: What process was used to capture the EFT card data? Canonical values are:
  • BarCode
  • CertMagRead
  • ChipRead
  • ElecMer
  • Keyed
  • MagRead
  • OCR
  • Trak
  • UnCertChipRead
EftDesc
A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.
EFTMerId
The identification given to EFT card merchant transaction processors.
EFTMerStateCode
The two-character alpha code which represents a state. For example, MO.
EFTTrnAmt
The actual amount of the transaction accepted by the provider.
EFTTrnAuthAmt
The amount for which an EFT transaction was authorized.
EFTTrnAuthDt
The date an EFT transaction was authorized.
EFTTrnCode
The code that defines the type of 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.
ExcRsnCode
The code that describes the reason for the exception.
ExcRsnDesc
The description of the code that describes the reason for the exception.
MerBusCatDesc
The business category description as related to a merchant.
MerCity
The city name.
MerName
The name of the merchant that processed the POS transaction.
MerPostalCode
The postal code or ZIP code.
TrnRef
An application's transactional reference that provides guidance as to the source.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_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_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022