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

Card Alert Notification Inquiry

Enterprise SOAP API > API by Reference > Card Services > Card Alert Notification Inquiry

Card Alert Notification Inquiry

Card Alert Notification Inquiry is a jXchange service designed to provide all the information as related to card alert notification.

Message Flow

In jXchange, the Card Alert Notification Inquiry service uses a typical exchange of MType messages to provide all the information as related to card alert notification.

Primary Request

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

  • AlrtId

The message contains the following complexes:

  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the CardAlrtNotfInqRq_MType message to the consumer. The message contains the following simple element:

  • AlrtId

The message contains the following complexes:

  • CardAlrtNotfInqRec_CType
  • Custom_CType
  • MsgRsHdr_CType

Card Alert Notification Inquiry Behavior

The Card Alert Notification Inquiry service behavior is as follows.

The Card Alert Notification Inquiry (CardAlrtNotfInqRq_MType) root request requires the Alert Identifier (AlrtId).

The Card Alert Notification Inquiry (CardAlrtNotfInqRs_MType) root response returns Alert Identifier (AlrtId) and Card Alert Notification Inquiry record complex (CardAlrtNotfInqRec_CType), which contains the following elements:

  • Account Identifier Mask (AcctIdMask)
  • Account Type (AcctType)
  • Card Alert Category Description (CardAlrtCatDesc)
  • Card Alert Code (CardAlrtCode)
  • Card Alert Message (CardAlrtMsg)
  • Currency Type (CurrType)
  • Currency Type Symbol (CurrTypeSymb)
  • Customer Identifier (CustId)
  • EFT Card Mask Number (EFTCardMaskNum)
  • EFT Card Type (EFTCardType)
  • EFT Merchant Country (EFTMerCntry)
  • EFT Merchant Identifier (EFTMerId)
  • EFT Merchant State Code (EFTMerStateCode)
  • EFT Merchant State Province (EFTMerStatProv)
  • EFT Transaction Amount (EFTTrnAmt)
  • EFT Transaction Channel Code (EFTTrnChanCode)
  • EFT Transaction Channel Description (EFTTrnChanDesc)
  • EFT Transaction Code (EFTTrnCode)
  • EFT Transaction Description (EFTTrnDesc)
  • EFT Transaction Processing Time (EFTTrnProcTime)
  • EFT Transaction Reversal Amount (EFTTrnRevAmt)
  • EFT Transaction Reversal Time (EFTTrnRevTime)
  • EFT Transaction Status (EFTTrnStat)
  • EFT Transaction Status Description (EFTTrnStatDesc)
  • EFT Transaction Time (EFTTrnTime)
  • Email Address (EmailAddr)
  • Exception Reason Code (ExcRsnCode)
  • Financial Institution Name (FinInstName)
  • Merchant Business Category Code (MerBusCatCode)
  • Merchant Business Category Description (MerBusCatDesc)
  • Merchant City (MerCity)
  • Merchant Country Type (MerCntryType)
  • Merchant Name (MerName)
  • Merchant Postal Code (MerPostalCode)
  • Phone Number (PhoneNum)
  • Standard Industry Code (StdIndustCode)
  • Transaction Time Category (TrnTimeCat)

CardAlrtNotfInqRq_MType

CardAlrtNotfInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple element is contained within this complex.

AlrtId
The Alert Identification associated with Bill Pay.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request 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.

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.

CardAlrtNotfInqRs_MType

CardAlrtNotfInqRs_MType is a message MType element.

Contains:

  • CArdAlrtNotfInqRec_CType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple element is contained within this complex.

AlrtId
The Alert Identification associated with Bill Pay.

CardAlrtNotfInqRec_CType

CardAlrtNotfInqRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AcctIdMask
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
CardAlrtCatDesc
The description of the code as related to a card alert category.
CardAlrtCode
The code assigned to an alert for EFT cards.
CardAlrtMsg
The free-format message related to a card alert.
CurrTypeSymb
The symbol representation for a currency.
CurrType
The alphanumeric ISO 4217 currency code.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EFTCardMaskNum
The number that is assigned to an EFT card. The card number includes the ISO number.
EFTCardType
The classification of the EFT card. Canonical values are:
  • ATM
  • Credit
  • Debit
EFTMerCntry
The country abbreviation from ISO 3166.
EFTMerId
The identification given to EFT card merchant transaction processors.
EFTMerStateCode
The two-character alpha code which represents a state. For example, MO.
EFTMerStateProv
The state or province or region.
EFTTrnAmt
The actual amount of the transaction accepted by the provider.
EFTTrnChanCode
The code of the channel used for the EFT transaction.
EFTTrnChanDesc
The description of the channel used for the EFT transaction.
EFTTrnCode
The code that defines the type of EFT transaction.
EFTTrnDesc
The description of the code that defines the type of EFT transaction.
EFTTrnProcTimeDt
The time and date of the transaction.
EFTTrnRevAmt
The actual amount of the transaction accepted by the provider.
EftTrnRevTimeDt
The time and date of the transaction.
EFTTrnStatDesc
The description of the status of the EFT transaction.
EFTTrnStat
The status of the EFT transaction.
EFTTrnTimeDt
The time and date of the transaction.
EmailAddr
Email address.
ExcRsnCode
The code that describes the reason for the exception.
FinInstName
The depository financial institution name.
MerBusCatCode
The code of the merchant's business category.
MerBusCatDesc
The business category description as related to a merchant.
MerCity
The city name.
MerCntryType
The country abbreviation from ISO 3166.
MerName
The name of the merchant that processed the POS transaction.
MerPostalCode
The postal code or ZIP code.
PhoneNum
The phone number.
StdIndustCode
The standard industry code.
TrnTimeCat
Answers the question: What is the timing category for transactions? Canonical values are:
  • Immed
  • Recur
  • Sched

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_CType
  • MsgRecInfoArray_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_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 Soap Header Fault 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.

©1999-2020 Jack Henry & Associates, Inc.

Dates are provided as estimates only and can be changed at any time at the sole discretion of JHA.

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