Skip to main content

Display Deposit History

Introduction

The JHA SmartPay mRDC™ Web Service features the ability to display previous deposit history and images for the user with item and status information. In this guide, we will walk through how to use this feature within the mobile RDC application.

Getting Started

Task covered in this guide

  • How to display deposit history and images within the mRDC application

Required prerequisites before you continue

  • You will need to obtain your test credentials to try any of the examples in this guide. You should receive these from the Integrations team near the start of your project.
  • Download the mRDC Web Service WSDL file from the Downloads menu.
Deposit History With Images Workflow

Step 1 The user will select the option to view their deposit history within the mRDC application. Send the GetBatches request.

GetBatches Request Example

	{
        "__type":"GetBatchesRequest:#JackHenry.Eps.Mobile.RDC",
        "RequestDate":"/Date(1692650646000-0500)/",
        "RequestId":"6S54FD652154654F154654S3D2F1SD3",
        "Credentials":{
            "SecurityToken":"String Content",
        "PhoneKey":"String Content"
        }
	}

The GetBatches response provides batch-level information and batch-level events. Display the list of historical batches and status details to the user.

note

The number of days of deposit history the GetBatches response will return is based on the Deposit History setting that is configured by the organization. By default, this option is set to 5 previous days but can be configured to return up to 10, 30, or 90 days of deposit history. If your organization is considering selecting a time frame over 10 days, users who regularly process large amounts of transactions may experience timeouts when trying to pull 30 or 90 days' worth of deposits from the system.

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

  • SecurityToken - New token should be used in the next request.
  • BatchReference - A unique ID to identify an open batch that can be used in subsequent requests.

GetBatches Response Example

{
    "RequestId": "string",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "PhoneKey": "string",
        "SecurityToken": "String Content"
    },
    "Batches": [
        {
            "BatchNumber": "aa23cafd-5fd6-4035-a83f-8964aeca3890",
            "BatchReference": "B:5QHHSV1",
            "Events": [
                {
                    "Date": "/Date(1709246585863-0600)/",
                    "Description": "Sent to Processing"
                },
                {
                    "Date": "/Date(1709246584723-0600)/",
                    "Description": "Ready for Processing"
                },
                {
                    "Date": "/Date(1709246582400-0600)/",
                    "Description": "Needs No Attention"
                },
                {
                    "Date": "/Date(1709246548347-0600)/",
                    "Description": "Needs No Rescan"
                },
                {
                    "Date": "/Date(1709246547483-0600)/",
                    "Description": "Closed"
                },
                {
                    "Date": "/Date(1709246535463-0600)/",
                    "Description": "Updated"
                },
                {
                    "Date": "/Date(1709241398420-0600)/",
                    "Description": "Opened"
                }
            ],
            "LocationName": "General Account",
            "LocationReference": "L:T2PR",
            "Status": "BatchStatus02",
            "StatusDescription": "Deposited",
            "TotalAmount": 5.0000,
            "TotalCount": 1
        }
    ]
}

Step 2 The user will select a deposit (batch) from the list displayed in the app. Send the GetItems request.

GetItems Request example

{
	"__type":"GetItemsRequest:#JackHenry.Eps.Mobile.RDC",
	"RequestId":"da5sd146a5sd46as5d46651451236251",
	"RequestDate":"/Date(1692636069000-0500)/",
	"BatchReference":"B:5QHHSV1",
	"Credentials":{
		"PhoneKey":"String Content",
		"SecurityToken":"String Content"
}
}

The GetItems response provides item-level information and item-level events. Display the list of the items within the selected deposit (batch) with item status details and batch-level events.

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

  • SecurityToken - New token should be used in the next request.
  • ItemReference - The unique value assigned to each item.

GetItems Response example

{
    "RequestId": "da5sd146a5sd46as5d46651451236251",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "PhoneKey": "string content",
        "SecurityToken": "String Content"
    },
    "Items": [
        {
            "Amount": 5.0000,
            "BatchReference": "B:5QHHSV1",
            "Customer": null,
            "DataFields": [
                {
                    "FieldName": "String Content",
		    "FieldType":FieldType.Transaction,
                    "IsRequired": false,
                    "Text": "String Content",
                    "Validation": "String Content",
                    "ValidationMessage": "String Content",
                    "Value": "String Content"
                }
            ],
            "Events": [
                {
                    "Date": "/Date(1709246585850-0600)/",
                    "Description": "Sent to Processing"
                },
                {
                    "Date": "/Date(1709246535263-0600)/",
                    "Description": "Check Decision Performed"
                },
                {
                    "Date": "/Date(1709246535247-0600)/",
                    "Description": "Created"
                }
            ],
            "IQAStatus": "Nothing",
            "ItemReference": "I:75Q1KH5",
            "ProcessingStatus": "TransactionStatus102",
            "ProcessingStatusDescription": "Suspended",
            "Status": "ItemStatus13",
            "StatusDescription": "Sent to Processing",
            "TransactionReferenceNumber": "T:V5XLD5TQLS2"
        }
    ]
}

Step 3 The user selects an item to view the check image. Send the GetItemImages request.

GetItemImages Request Example

{
	"__type":"GetItemImagesRequest:#JackHenry.Eps.Mobile.RDC",
	"RequestDate":"/Date(1692651986000-0500)/",
	"RequestId":"da5sd146a5sd46as5d46651451236251",
	"ItemReference":"I:75Q1KH5",
	"Credentials":{
		"PhoneKey":"string",
		"SecurityToken":"string content"
		}
}

The GetItemImages response provides both the front and back images of the selected item. Display the images and the item-level events to the user.

Log the following information from the UpdateItem Response for use in subsequent requests:

  • SecurityToken - New token should be used in the next request.

GetItemImages Response Example

{
    "RequestId": "da5sd146a5sd46as5d46651451236251",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "PhoneKey": "string",
        "SecurityToken": "String Content"
    },
    "Images": {
        "BackImage": "Base64 Image String",
        "FrontImage": "Base64 Image String",
        "ItemReference": "I:75Q1KH5"
    }
}
Next steps

  • Review the API Reference - Please review the API Reference to see all APIs and their technical specifications.

  • Explore other 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.

  • Get certified and move into production - Ready to put your new code into production use? Refer to this process guide that explains our certification steps and how to contact us to get started.