Skip to main content

Overview

About JHA SmartPay Platform™️. Integrated Payments Platform that Supports Multiple Payment Channels.​

Owning the dynamic payments channel is getting more difficult with new competitors, new payment alternatives, and new end user expectations. But when you choose the JHA SmartPay Platform, you gain fully integrated solutions that support virtually every payment channel and the entire lifecycle of virtually every payment type. These industry-leading solutions can be implemented as a holistic payments ecosystem or as standalone solutions. And additional solutions can be easily added to support your evolving payments strategy and emerging payment channels. These solutions include.

  • JHA SmartPay Remote Deposit CompleteTM (RDC) – High-volume remote deposit capture with proofing and balancing services
  • JHA SmartPay Remote Deposit NowTM (RDN) – High-volume remote deposit capture with business-managed proofing and balancing
  • JHA SmartPay mRDCTM (Mobile Remote Deposit Complete) – Commercial mobile remote deposit capture solution built exclusively for businesses
  • JHA SmartPay ExpressTM – Payments portal for online payments and donations
  • JHA SmartPay Biller DirectTM – Electronic bill/invoice presentment and payment solution for billers
  • JHA SmartPay CardTM – Cost-effective card transaction processing for small and large merchants
  • JHA SmartPay ACHTM – Sophisticated bulk file or individual ACH transaction processing
  • JHA SmartPay ManagerTM – Intelligent administrative portal

About the JHA Transaction Reporting Web Service​

The Transaction Reporting Web Service exposes a set of application program interfaces (APIs) that enables a way to retrieve transaction information from the JHA SmartPay Platform for building custom reports and keeping transaction data current within your application. Enterprise Payment Solutions (EPS) robust APIs can be configured and deployed to offer highly scalable payment solutions for near-term needs, with the flexibility to quickly and seamlessly add payment options to support evolving business strategies and market demands. Following are the features that are available through the Transaction Reporting API’s.

List of features​

  • Credits and Debits Report Ability to pull detailed transaction information on credit and debit settlements EPS has made to merchant accounts and locations.
  • Collections Report Ability to pull information on collection activity for transactions within SmartPay.
  • Events Report Ability to pull specific event information (Approved, Processed, etc.) that has occurred on transactions within SmartPay.
  • Transactions Report Ability to pull detailed information, including statuses, on transactions that have processed through SmartPay.

Required, System Required/User Optional and Optional Data Elements

Required Data Elements​

Some data elements contained within TransactionReporting that are required and the applicable data will be provided to you by EPS when your merchant account has been set up. These required elements are shown below.

  • 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 master 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.
  • locationIds – LocationIds is a unique identifier for each location (account) set up for a user and provided by ProfitStars EPS when an account has been set up. Users that process transactions for multiple accounts or use the same account for multiple purposes (i.e. building fund, donations, dues), will be assigned individual location IDs for each. To retrieve data for all locations for a merchant this element can be a list of all locations or a value of “0”.
  • wsdisplayFields – This element represents the available fields for a report. Note: (d) to the right of a field name designates it as a default field that will be returned if the element has “__NONE” in the request.
    note

    Only those fields required by the EPS system will de denoted by a Y in the Required column.

Optional Data Elements​

For some optional elements, if the element is included in the request, then a value must be provided by the user. This means that the element can be null but cannot be empty. These elements are listed below.

  • wstransStatus – This element represents the possible statuses of a transaction. To retrieve every status of a transaction this element can either be excluded from the request or included with a value of “__NONE”.
  • wssettlementType – This element represents the transaction type – Check (ACH or Image) orcredit card. To retrieve all settlement types this element can either be excluded from the request or included with a value of “None”.
note

The element wssettlementType is equivalent to the “OriginatedAs” option on the SmartPay Business.

  • wspaymentType – This element represents the type of payment being requested – checking, money order, Master Card etc. To retrieve transactions of all payment types this element can either be excluded from the request or included with a value of “__NONE”
  • wspaymentOrigin – This element identifies by what method the transaction was originated. To retrieve transactions for every origination, type this element can either be excluded from the request or included with a value of “__NONE”.
  • wssettlementStatus – This element represents the settlement status of the transaction – Settled, To Be Originated etc. To retrieve every settlement status of a transaction this element can either be excluded from the request or included with a value of “__NONE”.
  • wsauthResponseCode – This element designates the response code of a transaction. If null, the default value of “Success” is used.
  • wsopType – This element represents the operation type of transactions (Sale, Credit, and Auth etc.). If null, the default value of “Sale” is assumed. This document will make every effort to identify each of these element types within a method.

Notice of Change (NOC) Codes​

The following list contains those C Codes that EPS currently acts on.

C01: Invalid_Account_Number

C02: Incorrect_Routing_Number

C03: Incorrect_Routing_And_Account_Number

C04: Incorrect_Receiver_Name

C05: Incorrect_Transaction_Code

C06: Incorrect_Account_Number And_Transaction_Code

C07: Incorrect_Routing_And_Account_And_Transaction_Code

C08: Incorrect Foreign_Receiving_DFI

C09: Incorrect_Individual_Identification_Number

C10: Incorrect_CompanyName

Data Returned Limitation​

Requests for data that exceeds 100k records will return a TR01 error response as displayed below.

“Server was unable to process request. ---> An exception of type System.ApplicationException was thrown. The message was TR01 - The amount of data you requested exceeds system limitations and cannot be processed. Reduce the input range and submit your request again.”

Data Retention Policy​

Report requests for data older than two years will not retrieve any results. The data available for this report is limited to the most recent two years, in accordance with the ProfitStars Enterprise Payment Solutions (EPS) Data Retention policy.

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.