Skip to main content

Overview

Web Services​

A web service is an interface between different web-based application sources that provides them with the ability to communicate with each other without any custom coding or knowledge of each other’s systems. According to Webopedia.com, they can “share business logic, data and processes through a programmatic interface across a network.” Enterprise Payment Solutions (EPS) web services are used to send transaction operations to EPS via the internet.

EPS BIN Lookup API​

This document concentrates on the EPS BIN LOOKUP API. The EPS BIN Lookup API was created to provide integrators with a scalable and modern solution to determine if a payment card is a Credit only or a Dual Mode Debit through the SmartPay Platform.

note

IMPORTANT: The information in this document is built around the use of a REST client. Results may vary by source application used.

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

Required Data Elements​

There are some elements contained within BIN Lookup that are required and the applicable data will be provided to you by Jack Henry EPS when your merchant account 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. POST is the only supported method in this document.
  • Content-Type – A request header field used to declare the type of payload sent in an HTTP request. As the BIN Lookup API is built around a JSON format, this value is typically expected to be application/json.
  • Token – A temporary Bearer Token provided in response to a successfully authenticated card-processing/token request. This Bearer Token value is then expected in further requests on behalf of the verified user for the target entityId/locationId.
  • storeId – A unique user ID systematically generated by EPS upon installing a web service user. The storeId can be unique to each individual merchant, or a storeId can be assigned at the reseller/owner level.
  • storeKey – A unique password systematically generated by EPS upon installing a web service user. The password corresponds with the storeId above.
  • entityId - The entityId is a unique identifier that is systematically generated when the merchant is installed on the EPS system. It is also referred to as the Merchant ID or MID.
  • locationId - The locationId is a unique identifier for each location (account) set up under a user.
note

Required fields are identified by a Y in the required column.