Skip to main content

Overview

About the JH SmartPay Merchant Boarding Web Service​

The JH SmartPay Merchant Boarding application programming interface (API) includes an efficient method of automating business customer boarding of customer profile, product, and feature configuration information into the JHA SmartPay Platform™, allowing financial institution (FI) customers to leverage JHA SmartPay Business™ (SPB) solutions.

Merchants can be boarded with services such as JHA SmartPay Remote Deposit Complete™ (RDC), JHA SmartPay Mobile Remote Deposit Complete™ (mRDC) and JHA SmartPay Remote Deposit Now™ (RDN), scanners, contact information and account information set up with velocity limits on the Merchant Default and/or location level.

GET functions are available to assist users with obtaining data once the merchant is boarded.

Jack Henry™ uses Representational State Transfer (REST) development coding style to make simple HTTPS requests to the server. This API will support REST calls—JavaScript® Object Notation (JSON).

List of features​

  • Boarding a Merchant - Upload an XML or JSON SmartPay Merchant Boarding File to board a merchant.
  • Create Import Settings - Create import settings for the file types uploaded.
  • Update Import Settings - Update the import settings pertaining to the financial institution.

Required, System Required/User Optional, and Optional Data Elements​

Required Data Elements​

Some elements contained within SmartPay Merchant Boarding Web Service methods are required, and the applicable data will be provided to you by Enterprise Payment Solutions when your FI entity has been set up. These required elements are shown below.

  • Endpoint - The target resource to be acted upon by the HTTP request.
  • Method - The action to take on the provided resource. There are several actions defined by the HTTP standard. GET, POST, and PUT are the only supported methods in this document.
  • Content-Type - A request header field used to declare the type of payload sent in an HTTP request. As the SmartPay Merchant Boarding Web Service is built around a JSON format, this value is typically expected to be application/JSON. Exceptions are noted in the resource documentation.
  • Token - A temporary Bearer Token provided in response to a successfully authenticated gettoken request. This Bearer Token value is then expected in further requests on behalf of the verified user for the target entityID.
  • storeId - A unique user ID systematically generated by EPS upon installing a new web service user.
  • storeKey - A unique password systematically generated by EPS upon installing a web service user. The password corresponds with the storeID above.
  • entityId - This is the ID of an entity that has been identified as an Owning Entity. This method cannot be executed at the individual merchant level.
  • importSettingID - The Import Setting ID assigned to the file type currently set for the FI.
  • fileId - ID of the file that was assigned and provided in the Boarding File Upload response when the file was uploaded.
note

Required fields are designated with a “Y" in the required column.

Optional Data Elements​

The elements below are user-defined values that are not required to submit the request.

  • userName - First and last name of the user performing the upload.

System Requirements​

Secure Sockets Layer (SSL) Implementation Required​

Requests must be originated using HTTPS protocol. This requires requesting servers/users to use the Secure Socket Layer (SSL) for encrypted communication.