Class NotificationsRequest

Properties

NAME	TYPE	LENGTH	DESCRIPTION	EXAMPLES
ECVersion	String	N/A	Applicable for all ECAlertEventId IDs (see below). Version of the API	" ECVersion ": "N.1.2"
ECAlertEventId	String (Integer)	10	Applicable for all ECAlertEventId IDs. The alert event ID for the request. The description for other parameters may refer to these IDs as not all parameters are applicable to all event IDs: 2 = Deposit Submitted 5 = Deposit Item Approved – No Amount Adjustment 6 = Deposit Item Approved – Amount Adjusted Down 7 = Deposit Item Approved – Amount Adjusted Up 8 = Deposit Item Rejected 38 = Batch Review Complete	"ECAlertEventId": "8"
ECAlertLogId	String (Integer)	10	Applicable for all ECAlertEventId IDs. The unique ID for the alert event request. The two main uses for this ID are: To be used by the Financial Institution for researching the request/response within EZAdmin If supporting the auto-resend functionality, use this ID to validate that the alert has not previously been processed. (See Section	"ECAlertLogId": "121252"
ECAlertLogDTTMMilitary	String (Datetime)	N/A	Applicable for all ECAlertEventId IDs. Timestamp for when the Alert Log entry was created; formatted in military time (PT time zone). Format: YYYY-MM-DDTHH:MM:SS	"ECAlertLogDTTMMilitary": "2019-11-04T09:30:44"
DataItems	DataItems[]		Applicable for all ECAlertEventId IDs. Array of DataItems pertaining to the transaction.	"DataItems": [ { "Name": "ECAcceptedBy", "Value": "Test FI" } ]
SubItems	SubItems[]		Applicable for all ECAlertEventId IDs. Array of SubItems pertaining to the transaction.	"SubItems": [ { "ItemType": "DEPOSITITEM" "DataItems": [ { "Name": "ECTransactionDate", "Value": "November 04, 2019 9:30 AM PT" } ] } ]

DataItems

NAME	TYPE
Name	String
Value	String

SubItems

NAME	TYPE	DESCRIPTION	EXAMPLES
ItemType	String	Applicable for all ECAlertEventId IDs. Static value of "DEPOSITITEM"
DataItems	DataItems[]	Applicable for all ECAlertEventId IDs. Array of DataItems pertaining to the transaction.

DataItems Attributes

Attribute Name	Type	Descriptions
ECAcceptedBy	String	Applicable for all ECAlertEventId IDs. The name of the Financial Institution that accepted the deposit. The Financial Institution name is presented here as is configured in our system and may be adjusted at any time by request from the Financial Institution. We do not recommend hard coding any functionality off the name provided here.
ECAcquirerID	String(Integer)	Applicable for all ECAlertEventId IDs. The Acquirer ID (also sometimes referred to as the Partner ID) is a unique ID assigned by JHA/Ensenta that is specific to the Financial Institution’s specific product instance within JHA/Ensenta’s platform. The ID is different for each environment (UAT and Production). An Acquirer ID for your solution’s development team will be provided as part of the initial integration to Smart Alerts for certification purposes and will be specific to the UAT environment only. For onboarding a specific Financial Institution, a separate Acquirer ID will be assigned by Ensenta for each environment (UAT and Production). If this interface is planned to be used for multiple products/instances, it is recommended to maintain a lookup table on your end using ECAcquirerID as the unique id which can then be used to define any details around your solution that Financial Institutions may desire to be handled differently.
ECReceiptNumber	String	Applicable for all ECAlertEventId IDs. The Receipt Number is a value that uniquely represents the transaction.
ECUnmaskedAcctHolderNum	String	Applicable for all ECAlertEventId IDs. Commonly referred to as the Account Holder Number, this is a unique identifier that typically represents the individual End-User or business/merchant. Banks: Business Mobile/Desktop: Commonly used values are the Tax Identification Number (TIN) or Service Level Agreement (SLA) number from the Core system. Consumer Mobile/Desktop: Commonly used values are the Social Security Number (SSN) or Service Level Agreement (SLA) number from the Core system. Credit Unions: Business Mobile/Desktop: Member Number is the most commonly used value Consumer Mobile/Desktop: Member Number is the most commonly used value This value is commonly determined by the Financial Intuition, the SSO vendor (how the user logs into the product to make the deposit), and JHA/Ensenta. Work with your JHA/Ensenta project manager to identify the format for Account Holder Number.
ECUnmaskedAcctNum	String	Applicable for all ECAlertEventId IDs. Commonly referred to as the Account Number, the format of the account number may need to be manipulated by your solution to support downstream processing of the transaction. If supporting multiple Financial Institutions with your solution, it is recommended to allow for flexibility in manipulating the account number that you receive as there may be other requirements in how this value is leveraged for files that JHA/Ensenta outputs for the Financial Institution. JHA/Ensenta will work with you to identify the account number formatting for the Financial Institution.
ECFundsAvailabilityText	String	Applicable for all ECAlertEventId IDs. A static set of text commonly displayed in the user interface to the end-user when submitting the deposit (depends on the product and integration if this is being displayed). The text itself is intended to provide a simple description of the Financial Institution’s funds availability policy. In the standard JHA/Ensenta email notifications, this text is included within the emails sent to the end-user. The text is presented here as is configured in our system and may be adjusted at any time by request from the Financial Institution.
ECPhoneNumber	String	Applicable for all ECAlertEventId IDs. Optionally the Financial Institution can provide a phone number that is intended to be used in the notification as a phone number the end-user can reach out to regarding any questions. As a note, if the Financial Institution does not provide a phone number, the default verbiage is most commonly "your Financial Institution" as it is generic text used in the standard JHA/Ensenta email notifications. The text is presented here as is configured in our system and may be adjusted at any time by request from the Financial Institution.
ECGenericText1	String	Applicable for all ECAlertEventId IDs. Optionally the Financial Institution can provide a generic set of text to be included in the notification. There is no specific expectation for what the text should be, but this parameter may be useful to leverage if your solution is not easily updated. The text is presented here as is configured in our system and may be adjusted at any time by request from the Financial Institution.
ECGenericText2	String	Applicable for all ECAlertEventId IDs. Optionally the Financial Institution can provide a generic set of text to be included in the notification. There is no specific expectation for what the text should be, but this parameter may be useful to leverage if your solution is not easily updated. The text is presented here as is configured in our system and may be adjusted at any time by request from the Financial Institution.

| ECOriginalBatchAmountNoCurrency | String (Numeric) | Applicable for ECAlertEventId IDs: 2, 38

Original amount of the deposit (as submitted by the end-user); intended to be informational. The below ECApprovedBatchAmountNoCurrency should be used for the approved amount of the deposit.

| ECAdjustedBatchAmountNoCurrency | String (Numeric) | Applicable for ECAlertEventId IDs: 2, 38.

The difference between the original and approved amounts of the deposit.

| ECApprovedBatchAmountNoCurrency | String (Numeric) | Applicable for ECAlertEventId IDs: 2, 38

The approved amount of the deposit after any adjustments.

| |

SubItems.DataItems Attributes

Attribute Name	Type	Descriptions
ECTransactionDate	String(Datetime)	Applicable for all ECAlertEventId IDs. Date that the check was submitted. Standard Format is Month DD, YYYY HH:MM TT PT NOTE: The format of this value may be different if the Financial Institution has requested it be changed as it impacts other parts of their setup.
ECCheckNumber	String	Applicable for all ECAlertEventId IDs. The check number from the MICR of the check: For personal checks, will extract the value from the On-Us if present. For business checks, will copy the value from the Auxiliary On-Us if present. NOTE: If supporting Multiple Status Alert Events and the Financial Institution re-visits a check that they previously approved or rejected and makes an update, be aware that an updated alert event is only sent if an update is made to the status and/or amount of the check. If the only change is an update to the MICR, an updated alert event will NOT be sent.
ECOriginalAmountNoCurrency	String(Numeric)	Applicable for all ECAlertEventId IDs. Original amount of the deposit (as submitted by the end-user); intended to be informational. The below ECApprovedAmountNoCurrency should be used for the current amount of the check.
ECApprovedAmountNoCurrency	String(Numeric)	Applicable for all ECAlertEventId IDs. The current amount of the deposit after any adjustments.
ECRejectReasonCode	String	Only applicable for ECAlertEventId = 8 (Deposit Item Rejected). The reject reason code (also known as return reason code) is the code that represents the reason the Financial Institution is not able to accept the check. The parameters ECRejectReason and ECRejectReasonOverride below are related to the reject reason code. The Financial Institution may have customized the reject reason codes, but for the standard list, see Standard Reject Reasons.
ECRejectReason	String	Only applicable for ECAlertEventId = 8 (Deposit Item Rejected). The reject reason (also known as the return reason) is the internal description associated with the reject reason code from ECRejectReasonCode above. The Financial Institution may have customized the reject reasons, but for the standard list, see Standard Reject Reasons.
ECRejectReasonOverride	String	Only applicable for ECAlertEventId = 8 (Deposit Item Rejected). The reject reason override (also known as return reason override) is the external description (end-user facing) associated with the reject reason code from ECRejectReasonCode above (it will match with ECRejectReason if an override description was not defined). The Financial Institution may have customized the reject reason overrides, but for the standard list, see Standard Reject Reasons.
ECCheckFrontBase64	String	Applicable for all ECAlertEventId IDs. This is the Base64 string of front image. Will be the binarized (black and white) version of the image in tiff format.
ECCheckBackBase64	String	Applicable for all ECAlertEventId IDs. This is the Base64 string of back image. Will be the binarized (black and white) version of the image in tiff format.

Standard Reject Reasons

Reason Code (ECRejectReasonCode)	Description (ECRejectReason)	Description Override (ECRejectReasonOverride)
1	Numeric and written amounts different
2	Missing 'For Mobile Deposit Only' with endorsement
8	Endorsement does not meet requirements
9	IRD User Defined-See Return Text Overlay
A	NSF – Not Sufficient Funds
B	UCF – Uncollected Funds Hold
C	Stop Payment
D	Closed Account
E	UTLA – Unable to Locate Account
F	Frozen/Blocked Account
G	Stale Dated
H	Post Dated
I	Endorsement Missing
J	Endorsement Irregular
K	Signature(s) Missing
L	Signature(s) Irregular
M	Non-Cash Item (Non Negotiable)
N	Altered/Fictitious Item
O	Unable to process (e.g. Mutilated Item)
P	Item Exceeds Dollar Limit
Q	Not Authorized
R	Branch/Account Sold (Wrong Bank)
S	Refer to Maker
T	Stop Payment Suspect
U	Unusable Image
V	Image Fails Security Check
W	Cannot Determine Amount
Y	FI Prohibited Item
Z	My Deposit Prohibited Item

Examples

{
	"ECVersion": "N.1.2",
	"ECAlertEventId": "2",
	"ECAlertLogId": "122946",
	"ECAlertLogDTTMMilitary": "2019-11-04T09:30:44",
	"DataItems": [
		{
			"Name": "ECAcceptedBy",
			"Value": "Test FI"
		},
		{
			"Name": "ECAcquirerID",
			"Value": "8257"
		},
		{
			"Name": "ECReceiptNumber",
			"Value": "93083182"
		},
		{
			"Name": "ECUnmaskedAcctHolderNum",
			"Value": "55555"
		},
		{
			"Name": "ECUnmaskedAcctNum",
			"Value": "12345"
		},
		{
			"Name": "ECFundsAvailabilityText",
			"Value": "Funds availability: Availability of your deposited funds is based on your financial institutions hold policies. Please retain your deposited check for 60 days and then securely destroy it."
		},
		{
			"Name": "ECPhoneNumber",
			"Value": "(555) 555-5555"
		},
		{
			"Name": "ECGenericText1",
			"Value": "Example Generic Text 1."
		},
		{
			"Name": "ECGenericText2",
			"Value": "Example Generic Text 2."
		}
	],
	"SubItems": [
		{
			"ItemType": "DEPOSITITEM"
			"DataItems": [
				{
					"Name": "ECTransactionDate",
					"Value": "November 04, 2019 9:30 AM PT"
				},
				{
					"Name": "ECCheckNumber",
					"Value": "000001"
				},
				{
					"Name": "ECOriginalAmountNoCurrency",
					"Value": "5.00"
				},
				{
					"Name": "ECApprovedAmountNoCurrency",
					"Value": "5.00"
				},
				{
					"Name": "ECRejectReasonCode",
					"Value": ""
				},
				{
					"Name": "ECRejectReason",
					"Value": ""
				},
				{
					"Name": "ECRejectReasonOverride",
					"Value": ""
				},
				{
					"Name": "ECCheckFrontBase64",
					"Value": "<!-- Base64 Image -->"
				},
				{
					"Name": "ECCheckBackBase64",
					"Value": "<!-- Base64 Image -->"
				}
			],
		}
	]
}

Properties​

DataItems​

SubItems​

DataItems Attributes​

SubItems.DataItems Attributes​

Standard Reject Reasons​

Examples​