Display Limits and Counts

Introduction

In this workflow guide, we will walk through how to display the current velocity limits and counts within the JHA SmartPay Remote Deposit Anywhere™ (referred to as Consumer Mobile or RDA) web service.

Getting Started

Each step in the workflow diagram is a hyperlink that will take you to the API reference information for the method being used.

Tasks covered in this guide:

Step 1: Send Authenticate Request
Step 2: Send Get Velocity Request

Required prerequisites before you continue:

Review the RDA Authentication Guide to understand how to authenticate to the JHA SmartPay Remote Deposit Anywhere™ (referred to as Consumer Mobile or RDA).
Download the RDAWebServices WSDL file under the Downloads page.

JHA SmartPay Remote Deposit Anywhere™ (referred to as Consumer Mobile or RDA) Velocity Counts and Limits Workflow

Display Limits and Counts Diagram

	Integrator Mobile Deposit Flow	EPS RDA Mobile Deposit Flow

	EPS Web Service

1.	Send Authenticate SSO request
		Authenticate response with security token
2.	Send GetVelocity request (in the RDA web service, not Admin) using authenticated security token
	The returned data can be used to display both the threshold and current usage to the user Limit fields show their threshold Count and amount fields show their current usage under the threshold	GetVelocity response with security token

Send Authenicate Request

Step 1: Send Authenticate Request

Send an Authenticate Request with the necessary information.

Request ID
Request Date
Credentials
Device Tracking
PhoneKey

note

For more details on the required information above, see the Authenticate Request API reference page. Also refer to the RDA Authentication Guide for a full explanation of the authentication components and parameters.

The newest security token is required to complete each subsequent request. You can get the newest security token from each web service response. If more than 15 minutes have passed between successful requests, a new authenticate request will need to be sent.

Authenticate Request Example

    {
    "Credentials":{
        "__type":"SSOCredentialsSHA256:#JackHenry.Eps.Mobile.RDA",
        "FIIdentifier":"456789",
        "Hash":"String Content",
        "HomeBankingId":"1234",
        "SaltValue":"xyz",
        "Timestamp":"/Date(1560817240000-500)/",
        "PhoneKey":"1"
        },
    "DeviceTracking":{
        "AppBundleId":"testbundleid",
        "AppVersion":"1.0",
        "DeviceModel":"android",
        "DeviceSystemName":"testuserandroid",
        "DeviceSystemVersion":"1.0",
        "Vendor":"Your Company Name Here"
    },
    "RequestDate":"/Date(1560817240000-500)/",
    "RequestId":"123456789"
    }

Authenticate Response Example

Log the following information from the AuthenticatedResponse for use in subsequent requests:

SecurityToken

{
    "RequestId": "123456789",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "SecurityToken": "String Content"
    },
    "PromptTermsAndConditions": false
}

Send Get Velocity Request

Step 2: Send a GetVelocity Request

note

This action pulls the current velocity limits and counts.

GetVelocity Request Example

{
    "__type": "GetVelocityRequest:#JackHenry.Eps.Mobile.RDA",
    "RequestId": "123456789",
    "RequestDate": "/Date(1629199027219-500)/",
    "Credentials": {
        "__type": "TokenCredentials:#JackHenry.Eps.Mobile.RDA",
        "SecurityToken": "String Content"
    }
}

GetVelocity Response Example

note

The returned data can be used to display both the threshold and current usage to the user.

Limit fields show their threshold, while count and amount fields show their current usage under the threshold.

{
 	"__type":"GetVelocityResponse:#JackHenry.Eps.Mobile.RDA",
 	"Velocity":
		{
       	"__type":"Velocity:#JackHenry.Eps.Mobile.RDA",
       	"DailyCountLimit":0,
       	"DailyAmountLimit":12678967.54,
       	"PeriodCountLimit":0,
       	"PeriodAmountLimit":12678967.54,
       	"DailyCount":0,
       	"DailyAmount":12678967.54,
       	"PeriodCount":0,
       	"PeriodAmount":12678967.54,
       	"Action":
       	"SingleAmountLimit":12678967.54,
       	"IsEnabled":true,
		}
}

Handling Errors and Failed Requests

Not all requests will be successful, so we will cover a couple of common error messages you should be ready to handle.

RDA AuthenticateSSO Failure - This can happen for multiple reasons, the most common being a mismatched hash in the request, a timestamp that is out of sync, or the user is not enrolled. For any scenario other than a user who is not enrolled, please reach out through your normal support channels for assistance and refer to the RDA Authenticate Guide in the RDA web service API Guides.

"Code" : "Auth-1001",
"Message" : "Authentication failed"

RDA AuthenticateSSO Invalid Hash Length Failure – This error response is returned if the hash being sent in the request is an invalid length. Check to make sure you are using the proper hashing algorithm that is compatible for the request type, either SHA 256 or SHA 512.

"Code" : "Cred 1232",
"Message" : "Hash Length is Invalid"

Next steps

Expore other Developer Guides - We have other guides to show how to leverage our APIs in other common use cases. If your situation or question is not covered in the current guide, consult another resource.
Review the API Reference section - This guide is a starting point to show common use case scenarios for making successful deposits. Please review the API Reference section to see all API methods and their technical specifications.
Review - FAQ and Best Practices documents for general information for preparation.