Enterprise Solutions

Card Alert Subscriber Inquiry

Enterprise SOAP API > API by Reference > Card Services > Card Alert Subscriber Inquiry
Card Alert Subscription Inquiry

Card Alert Subscription Inquiry

Card Alert Subscription Inquiry is a jXchange service designed to provide consumers with the ability to establish EFT card alerts and controls.

Message Flow

In jXchange, the Card Alert Subscription Inquiry service uses a typical exchange of MType messages to allow consumers to establish EFT card alerts and controls.

Primary Request

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

  • ActIntentKey
  • CustId
  • EFTCardNum

Primary Response

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

  • ActIntent
  • ActIntentKey
  • CustId
  • EFTCardNum

Card Alert Subscription Inquiry Behavior

The Card Alert Subscription Inquiry service behavior is as follows.

The Card Alert Subscription Inquiry (CardAlrtSubInqRq_MType) root request requires Customer Identification (CustId) and EFT Card Number (EFTCardNum).

The Card Alert Subscription Inquiry (CardAlrtSubInqRq_MType) optionally includes the Activity Intention (ActIntent).

The Card Alert Subscription Inquiry (CardAlrtSubInqRs_MType) root response returns the following elements:

  • Customer Identifier (CustId)
  • EFT Card Number (EFTCardNum)
  • Activity Intention (ActIntent)
  • Activity Intention Key (ActIntentKey)
  • Card Alert Subscription Inquiry complex (CardAlrtSubInqRec_CType)

The Card Alert Subscription Inquiry record complex (CardAlrtSubInqRec_CType) contains the following elements:

  • Common Name (ComName)
  • Email Address (EmailAddr)
  • Phone Number (PhoneNum)
  • Card Alert Subscription Array (CardAlrtSubArray_AType)

The Card Alert Subscription Record complex (CardAlrtSubInqRec_CType) contains the following elements:

  • EFT Card Number (EFTCardNum)
  • Activity Intention Key (ActIntentKey)
  • Card Alert Array (CardAlrtArray_AType)

The Card Alert Array (CardAlrtArray_AType) contains the Card Alert Record complex (CardAlrtRec_CType), which contains the following elements:

  • Alert Activity Type (AlrtActType)
  • Card Alert Category Type (CardAlrtCatType)
  • Card Alert Code (CardAlrtCode)
  • Card Alert Description (CardAlrtDesc)
  • Card Alert Region Latitude (CardAlrtRegionLat)
  • Card Alert Region Longitude (CardAlrtRegionLong)
  • Card Alert Region Radius (CardAlrtRegionRadius)
  • Card Alert Region User Description (CardAlrtRegionUsrDesc)
  • Card Alert Threshold Array (CardAlrtThldArray_AType)

The Card Alert Threshold Array (CardAlrtThldArray_AType) contains the following elements:

  • Card Alert Threshold Code (CardAlrtThldCode)
  • Card Alert Threshold Description (CardAlrtThldDesc)
  • Card Alert Threshold Value (CardAlrtThldVal)
  • Card Alert Threshold Activity Type (CardAlrtThldActType)

CardAlrtSubInqRq_MType

CardAlrtSubInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this complex.

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.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EFTCardNum
The number that is assigned to an EFT card. The card number includes the ISO number.

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.

CardAlrtSubInqRs_MType

CardAlrtSubInqRs_MType is a message MType element.

Contains:

  • CardAlrtSubInqRec_CType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this complex.

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.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EFTCardNum
The number that is assigned to an EFT card. The card number includes the ISO number.

CardAlrtSubInqRec_CType

CardAlrtSubInqRec_CType is a complex CType element.

Contains:

  • CardAlrtSubArray_AType
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
EmailAddr
Email address.
PhoneNum
The phone number.
CardAlrtSubArray_AType

CardAlrtSubArray_AType is an array AType element. This is an array of EFT card alert subscriptions.

Contains:

  • CardAlrtSubRec_CType
CardAlrtSubRec_CType

CardAlrtSubRec_CType is a complex CType element.

Contains:

  • CardAlrtArray_AType
Simple Elements

The following simple elements are contained within this complex.

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.
CardAlrtArray_AType

CardAlrtArray_AType is an array AType element. This is an array of alerts related to a specific card.

Contains:

  • CardAltRec_CType
CardAlrtRec_CType

CardAlrtRec_CType is a complex CType element.

Contains:

  • CardAlrtThldArray_AType
Simple Elements

The following simple elements are contained within this complex.

AlrtActType
Answers the question: What is the activity status of an alert? Canonical values are:
  • Act
  • InAct
CardAlrtCatType
Identifies the category as related to an EFT card alert. Canonical values are:
  • Alrt
  • Cntl
CardAlrtCode
The code assigned to an alert for EFT cards.
CardAlrtDesc
The description of the code assigned to an alert for EFT cards.
CardAlrtRegionId
An identifier given to the region related to a card alert.
CardAlrtRegionLat
The Geolocation latitude.
CardAlrtRegionLong
The Geolocation longitude.
CardAlrtRegionRadius
The radius of a region for card alert in meters.
CardAlrtRegionUsrDesc
The name given by a user to identify a card alert region.
CardAlrtThldArray_AType

CardAlrtThldArray_AType is an array AType element. This is an array of thresholds related to a specific alert.

Contains:

  • CardAlrtThldRec_CType
CardAlrtThldRec_CType

CardAlrtThldRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

CardAlrtThldActType
What is the activity status of a threshold as related to an alert? Canonical values are:
  • Act
  • InAct
CardAlrtThldCode
The code assigned to thresholds as related to an alert for EFT cards.
CardAlrtThldDesc
The description of the code assigned to thresholds as related to an alert for EFT cards.
CardAlrtThldVal
The value as related to thresholds.

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.
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