Skip to main content

Custom Batch ID

Introduction

The JHA SmartPay mRDC™ Web Service offers the ability to allow a merchant user to enter a custom description of the batch for their reporting. This feature is controlled by the financial institution or Partner and is optional. If either of those entities choose to allow their customers to use this feature, the integrator should allow the customer enter a custom batch ID within the mRDC application.

Getting Started

Task covered in this guide

  • Entering a custom batch ID 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.
  • Review the Single Check Deposit Guide for an understanding of how to start the deposit workflow.
  • Download the mRDC Web Service WSDL file from the Downloads menu.
Custom Batch ID Workflow

Step 1 After the user has initiated the deposit workflow, but before the CreateBatch request, send the GetSettings request.

GetSettings Request Example

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

If the GetSettings response provides a value of "True" for the CustomBatchID element, display the CreateBatch screen to the user with a custom batch ID field. The user will then enter a value for the batch along with the rest of the batch information.

GetSettings Response Example

{
    "RequestId": "f89ur93iu983uj98ru923",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "PhoneKey": "65465146876",
        "SecurityToken": "String Content"
    },
    "AllowCreateCustomer": true,
    "AllowSaveUsername": true,
    "AllowUpdateCustomer": true,
    "EnablePasswordChange": true,
    "GeoLocationAccess": 0,
    "ShowCustomBatchId": false,
    "ShowDataEntry": true,
    "MiSnapLicense": null,
    "MiSnapLicenseIntegrator": null
}

Step 2 Send the CreateBatch request with the custom batch ID value in the BatchNumber field.

CreateBatch Request Example

{
	"__type":"CreateBatchRequest:#JackHenry.Eps.Mobile.RDC",
	"RequestDate":"/Date(1692650646000-0500)/",
	"RequestId":"f89ur93iu983uj98ru923",
	"Credentials":{
		"PhoneKey":"65465146876",
		"SecurityToken":"String Content"
	},
	"BatchNumber":"Unique Custom Batch ID string",
	"LocationReference":"L:T2PR"
}

Log the following information from the CreateBatch response 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.

CreateBatch Response Example

{
    "RequestId": "f89ur93iu983uj98ru923",
    "Result": 1,
    "ResultCode": null,
    "ResultMessage": null,
    "ValidationResults": [],
    "Credentials": {
        "PhoneKey": "65465146876",
        "SecurityToken": "String Content"
    },
    "Batch": {
        "BatchNumber": "Unique Custom Batch ID string",
        "BatchReference": "B:PTGSYV1",
        "Events": [
            {
                "Date": "/Date(1709760365707-0600)/",
                "Description": "Opened"
            }
        ],
        "LocationName": "General Account",
        "LocationReference": "L:T2PR",
        "Status": "BatchStatus05",
        "StatusDescription": "Open For Scanning",
        "TotalAmount": 0,
        "TotalCount": 0
    }
}
Handling Errors and Failed Requests

Not all requests will be successful. Below is a common error message you should be ready to handle.

  • Timeout waiting for response: Systems should be designed to wait 5 seconds to receive a response before timing out. If a timeout occurs, you can attempt to retry the request or reach out through your normal support channels for assistance.
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.