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

Notification Explicit Data Addition

Enterprise SOAP API > API by Reference > Notification Services > Notification Explicit Data Addition

Notification Explicit Data Addition

Notification Explicit Data Addition is a jXchange service designed to provide ENS publishers with the ability to target distribution to specific recipient contact points (e.g., email addresses and mobile numbers). This service also controls all alert message body and subject content and formatting.

Message Flow

In jXchange, the Notification Explicit Data Addition service uses a typical exchange of MType messages to provide ENS publishers with the ability to target distribution to specific recipient contact points (e.g., email addresses and mobile numbers). This service also controls all alert message body and subject content and formatting.

Primary Request

The consumer forwards the NotExplDataAddRq_MType message to the service provider.

The message contains the following simple elements:

  • ConsumerProd
  • InstRtId

The message contains the following complex elements:

  • AlrtExplDataInfoRec_CType
  • Custom_CType
  • MsgRqHdr_CType

The message contains the following array:

  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the NotExplDataAddRs_MType message to the consumer.

The message contains the following simple elements:

  • AlrtPkgId
  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

Notification Explicit Data Addition Behavior

The Notification Explicit Data Addition (NotExplDataAdd) operation behavior is as follows.

The Notification Explicit Data Addition root request message (NotExplDataAddRq_MType) requires the Institution Routing Identification (InstRtId) and Consumer Product (ConsumerProd) simple elements and the Alert Explicit Data Information Record complex (AlrtExplDataInfoRec_CType).

The Alert Explicit Data Information Record complex (AlrtExplDataInfoRec_CType) encapsulates the elements required to create a successful explicitly defined alert request. The Alert Explicit Recipient array (AlrtExplRecipArray_AType) is required. The Alert Explicit Data Information Record complex (AlrtExplDataInfoRec_CType) optionally allows for the Send Delay Time Date (SndDlyTimeDt), Email Subject (EmailSubj), Email Sender (EmailSender), Email Text Body (EmailTextBody), Email HTML Body (EmailHTMLBody), and SMS Body (SMSBody) simple elements. The Send Delay Time Date (SndDlyTimeDt) simple element uses UTC format as governed by ISO 8601 time format.

The Alert Explicit Recipient Information Record complex (AlrtExplRecipInfoRec_CType) encapsulates a documented choice statement. Whereas the Distribution Group Identification (DistGroupId), Mobile Phone Number (MobPhoneNum), or Email Recipient Address (EmailRecipAddr) are optional, but at least one recipient is required. The Alert Explicit Recipient Information Record complex (AlrtExplRecipInfoRec_CType) should only contain one recipient type per complex. For example, the complex with a valid Distribution Group Identification (DistGroupId) and Email Recipient Address (EmailRecipAddr) simple elements would be considered invalid. The Alert SMS Type (AlrtSMSType) simple element default value is ~Native~. The Mobile Provider Code (MobPrvdCode) simple element is required when the Alert SMS Type (AlrtSMSType) simple element is ~SMTP~.

The Notification Explicit Data Addition root response message (NotExplDataAddRs_MType) returns an Alert Package Identification (AlrtPkgId) simple element upon a successful addition request.

Adhere to the tenets related to an addition service.

Adhere to the tenets related to fault and warnings conveyed in the message as related to business faults.

Adhere to the tenets related to backwards compatibility.

Adhere to the tenets related to enumerated elements.

NotExplDataAddRq_MType

NotExplDataAddRq_MType is a message MType element.

Contains:

  • AlrtExplDataInfoRec_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
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.

AlrtExplDataInfoRec_CType

AlrtExplDataInfoRec_CType is a complex CType element.

Contains:

  • AlrtExplRecipArray_AType
  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

EmailHTMLBody
The email body content.
EmailSender
The email address of the sender.
EmailSubj
The subject line for an email.
EmailTextBody
The email body content.
SMSBody
The SMS body content.
SndDlyTimeDt
The date and time that an alert is delayed. Expressed in ISO 8601 time format and should contain either Zulu time or local time and the UTC offset. Format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm].

AlrtExplRecipArray_AType

AlrtExplRecipArray_AType is an array AType element. This is an array of email recipients for an explicit alert.

Contains:

  • AlrtExplRecipInfoRec_CType
AlrtExplRecipInfoRec_CType

AlrtExplRecipInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AlrtSMSType
The alert SMS type. The canonical values are:
  • Native
  • SMTP

The default value is Native.

DistGroupId
An identifier assigned to an alert distribution group.
EmailRecipAddr
Email address.
EmailRecipName
The friendly name assigned to an email address.
MobPhoneNum
The phone number.
MobPrvdCode
The provider code for the mobile service.
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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType

ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

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.

NotExplDataAddRs_MType

NotExplDataAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

AlrtPkgId
An identifier assigned to an alert package.
RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

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