Class FraudRequest
Properties
| NAME | TYPE | LENGTH | DESCRIPTION | EXAMPLES |
|---|---|---|---|---|
| ECVersion | String | N/A | Applicable for all ECAlertEventId IDs (see below). Version of the API | " ECVersion ": "F.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:
| "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:
| "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 | EXAMPLES |
|---|---|---|---|
| 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:
Credit Unions:
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. | |
| ECAcctTypeCd | String | Applicable for all ECAlertEventId IDs. A code that identifies the type of account (as passed to Ensenta via the SSO). Possible Values:
Note: Check with the Financial Institution (FI) how they define Money Market accounts as some FIs will handle them as Savings and some as Checking. |
SubItems.DataItems Attributes
| Attribute Name | Type | Descriptions | EXAMPLES |
|---|---|---|---|
| ECTransactionDate | String | 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:
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. | |
| ECUnmaskedPayerAccountNumber | String | Applicable for all ECAlertEventId IDs. The On-Us (Account) from the MICR of the check. 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. | |
| ECPayerAuxOnUs | String | Applicable for all ECAlertEventId IDs. The Auxiliary On-Us (used for the check number on business checks) from the MICR of the check if present. If the Auxiliary On-Us is present, the value will match ECCheckNumber above. 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. | |
| ECExternalProcessingCode | String | Applicable for all ECAlertEventId IDs. The External Processing Code (EPC) from the MICR of the check 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. | |
| ECPayerRoutingNumber | String | Applicable for all ECAlertEventId IDs. The Routing Number from the MICR of the check. 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. | |
| ECGeoLocIPAddress | String | IP address of End-User if available. If available, the IP address may be IPv4 or IPv6 depending on what the upstream vendor provided. | |
| 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 |