What's New
Below are the changes made for each release.
Version 2.3 (April 2025)
Changes
- The following response code will be returned when the web service is unable to communicate with an internal EPS service.
Resource Code | Resource Text |
---|---|
WEB-1000 | Internal Service Error |
Version 2.2 (October 2024)
Changes
- A new property, MiSnapLicenseIntegrator, has been added to the GetSettingsResponse Properties in the mobile RDC (mRDC) webservice. This property will return, in the response, the Mitek MiSnap™ license key for use by Integrators and Mobile Banking Partner Resellers.
Please note these changes will require a WSDL update.
Version 2.1 (April 2024)
Changes
- A new property, MiSnapLicense, has been added to the GetSettingsResponse Properties in the mRDC webservice. This property will contain the Mitek MiSnap software license key that will be used internally by EPS only.
- A new property, OTP, has been added to the AuthenticateResponse Properties in the mRDC webservice. This property will contain the OTP status if further authentication is required.
Please note these changes will require a WSDL update.
Version 2.0 (April 2023)
Changes
After successful authentication to the mRDC webservices, if one of the below webservice methods is utilized and criteria is met the user will not be allowed to make a deposit. The following error message will be returned: "Deposit cannot be created at this time".
-
mRDC Webservice Methods:
-
Criteria (all criteria must be met):
- The Financial Institution has enabled the mRDC Geolocation service.
- The country associated with the device's IP address is not within the U.S. or U.S. Territory.
- The Geolocation Action of Prevent Remote Deposit Capture is enabled in SmartPay Manager.
Deprecated
Effective with the EPS April 2023 release, the following mRDC webservice request parameter within the AddItemRequest method and the response value within the GetSettingsResponse method will no longer be used (deprecated).
AddItemRequestParameter Parameter:
GetSettingsResponse Value:
Version 1.9 (October 2022)
Clarifications
- The CustomerType field in the GetCustomerFields method is defaulted to Individual if nothing is populated in that field.
Changes
- The following methods and criteria have been added to the mRDC web service to facilitate the ability to add or update a customer through the mRDC app.
- The following parameters have been added to the GetCustomerFieldsResponse property CustomerFields:
- CustomerData1
- CustomerData2
- CustomerData3
- The Customer object has been updated to include the following customer parameters:
- CustomerData1
- CustomerData2
- CustomerData3
- DaytimePhone
- DaytimePhoneExt
- EveningPhone
- EveningPhoneExt
- Fax
- IsCompany
- LocationReference
- SSNFedTaxId
- DLNumber
- DLState
- CustomerType
- Relationship
See the following web service methods that return the Customer object: - AddItemResponse
- CreateCustomerResponse
- GetCustomersResponse
- GetItemsResponse
- UpdateCustomerResponse
- UpdateItemResponse
- Added a new webservice method named, UpdateCustomer, which will allow a customer to be updated through the new mRDC webservices. The following are the request parameters:
note
For the UpdateCustomerRequest, the customer fields required are dynamic based on configuration.
-
- UpdateCustomerRequest Parameters:
- CustomerReference
- CustomerType
- LocationReference
- Relationship
- CustomerFields
- UpdateCustomerResponse Values:
- UpdatedCustomer
- UpdateCustomerRequest Parameters:
- The following settings were added to GetSettingsResponse:
- AllowCreateCustomer
- AllowUpdateCustomer
Version 1.8 (July 2022)
Changes
The following methods and criteria have been added to the mRDC web service to facilitate a new mRDC authentication token that can be used in lieu of a password. These new methods were created to support client-side biometrics for direct login and do not replace SSO authentication.
- RegisterForAuthTokenRequest Parameters
- UserName
- Company
- DeviceId
- PublicKeyBase64
- RegisterForAuthTokenResponse Values
- NewAuthToken
- ClearAuthTokenRequest Parameters
- UserName
- Company
- DeviceId
- AuthTokenCredentials as a type with the AuthenticateRequest which is inside the Authenticate method
AuthTokenCredentials Parameters- UserName
- Company
- DeviceId
- SignedDigestBase64
Version 1.7 (April 2020)
Changes
- Status ItemStatus10 has been removed.
- Added a new webservice method named, GetCustomerFields. The following are the request parameters and customer elements that will be returned in the response:
Note: For the GetCustomerFieldsResponse, the customer fields returned are dynamic based on configuration. - Added a new webservice method named, CreateCustomer, which will allow a customer to be created through the new mRDC webservices. The following are the request parameters:
Note: For the CreateCustomerRequest, the customer fields required are dynamic based on configuration.
Version 1.6 (October 2019)
Changes
- The following additional elements have been added to the GetBatches and GetItems method responses.
Note: There are WSDL changes as a result of this enhancement.- Added LocationReference element to the GetBatches method response.
- Added the below Customer and Transaction elements to the GetItems method response.
- Customer Elements
- AddressLine1
- AddressLine2
- City
- Country
- CustomerReference
- EmailAddress
- FirstName
- HomeBankingID
- LastName
- PostalCode
- State
- Transaction Elements
- Elements for a single Custom Transaction Data Field returned as an array
- FieldName
- FieldType
- IsRequired
- Text
- Validation
- ValidationMessage
- Value
- Customer Elements
Version 1.5 (July 2019)
Changes
- The new AddItemResponse Result messages that were added to the Validation Codes section of the documentation was inadvertently not added as documented in v1.4 (April 2019) but has how now been added to the documentation in v1.5.
- The descriptions for the Hash and Timestamp properties within the SSOCredentials Class have been updated to reflect the correct format of the timestamp along with the JSON example.
Version 1.4 (August 2019)
Changes
- The following new AddItemResponse Result messages will now be returned for deposits that are rejected up front.
RESULT CODE | RESULT MESSAGE |
---|---|
Item-2000 | Payment type is invalid |
Item-2001 | Check Amount and Entered Amount do not match |
Item-2002 | Mitek Processing Error (note: Generic message. The actual Mitek message will be returned) |
Item-2003 | Deposit cannot be accepted at this time (note: this message is returned for MICR denylist matches) |
Item-2004 | Invalid Check Endorsement (note: this is a default message. We will return all restrictive endorsement messages configured in Mitek) |
Item-2005 | Consumer Velocity is not configured |
Item-2006 | Consumer Velocity Exceeded Daily Amount |
Item-2007 | Consumer Velocity Exceeded Daily Count |
Item-2008 | Consumer Velocity Exceeded Period Amount |
Item-2009 | Consumer Velocity Exceeded Period Count |
Item-2010 | Consumer Velocity Exceeded Single Amount |
Item-2011 | Duplicate Transaction |
Version 1.3 (January 2019)
Changes
- SSOCredentials has been changed to reflect an updated description with an important note for the Hash property.
Version 1.2 (October 2017)
Changes
The JSON Date and Time format provided in responses to JSON requests has been updated to reflect the correct format.
- Example previous format: "Timestamp":"/Date(2017-08-21T16:37:19.835-500)/"
- Example corrected format: "Timestamp":"/Date(1503505595000-0000)/"
Version 1.1 (April 2017)
Changes
- AddItem will now accept GeoLocation for capturing the user's location from the device.
- SSOCredentials has been changed to a base class to allow for new types of Hashing.
- SSOCredentialsSHA256 and SSOCredentialsSHA512 are new options for the Authenticate method.
- Authenticate now requires DeviceTracking to be supplied.
- AddDeviceTracking has been removed. Merged with Authenticate.
- Removed ShowCustomerBatchId from CreateBatchRequest.
Version 1.0 (Octobe 2016)
New Methods
The items listed below have been updated and will behave differently if you are converting from the old web service.
- The service now sends items in decimals and not pennies.
- TokenCredentials will now be returned on each request to allow longer sessions. It is recommended that you use the latest SecurityToken on each new request.
- Each Request will now have a RequestId and RequestDate which will be used for tracking. The RequestId is a correlation id field to allow the integrator to send a value that exists in their logs that would match the EPS logs so that we can troubleshoot issues.
- It would be best if the RequestId followed a simple format. That way the EPS support team can track multiple requests across the session as well as individual requests.
- SessionId:RequestId
- example call 1: 7523be8a-0dc5-41b1-aac1-201667f3d13e:e195f48e-f964-423a-adb8-f17c76c528aa
- example call 2: 7523be8a-0dc5-41b1-aac1-201667f3d13e:72130a76-e9df-4a87-bfb2-c59a460062e9
- Get RDC Transactions was split into two new methods.
- Get RDC Customer Fields is now GetDataFields.
- Authenticate RDC User, Authenticate RDC User SSO, Authenticate RDC User w/MFA, and Submit MFA Questions and Answers have all been combined into one method: Authenticate.
- Change RDC Password is now UpdatePassword.
- Submit RDC Check Side and Deposit RDC Check are now AddItem.
- Get RDC Transaction Image and Get RDC Transaction Images are now GetItemImages.
- Deposit RDC Validated Check and Validate Check were removed. Validation is now done on AddItem