The EPI - E-Payment Interface

 

Overview | Concept | Licensing | Download | Installation | Sample Code | FAQ

Products | Scripts | Services | Tutorials | Books | Links | Contact | Bulletin Board

Please follow the links below to read the documentation specific to your gateway:

AuthorizeNet | BluePay | CyberCash | Echo Inc. | ESec | FirePay | GO Software(PCCharge)

iBill | Innovative Gateway | IntelliPay | Iongate | IPayment | LinkPoint | NovaInfo | PayBill

PayPal | PaySystems | Plug-n-Pay | Qenta | Skipjack | TeleCash | VeriSign | WorldPay

PaySystems

PaySystems is an US based company. PaySystems supports transactions in multiple currencies, which will be converted in US dollars using the daily conversion rate.

 

What you need to start

You receive from PaySystems the authentication data as follows:

  • Merchant ID
  • Merchant Password
  • The JPSClient java client, as a zip packed file.

 

Gateway Configuration Data

The PaySystems product homepage is under: http://www.paysystems.com/

This package uses a set of java modules to perform the transaction over a SSL backlink to the PaySystems transaction server

The Java Virtual Machine (JVM) v. 1.4.2 must be installed on the machine that will be running JPSclient. If you do not have the JVM installed, you can download J2SE SDK 1.4.2 or JRE 1.4.2 from http://java.sun.com/j2se/1.4.2/download.html (if you are running JPSclient through a webhost and cannot download and install JVM yourself, contact your service provider for help).

IMPORTANT: The PaySystems client software can only be run on a machine that has a static IP address. Dialup connections and certain types of dedicated connection assign a different IP address to your machine every time it connects to the internet. You may have to contact your service provider to make sure that your service package and/or connection type allows for a static IP address.

 

Payment Methods

The Supported payment methods are CreditCard, CorporateCard, and ACH The Documentation uses the term "ECheck", but the form parameters required correspond to an ACH transaction.

Valid values for -ACTION

For CreditCard and CorporateCard:

  • TEST
  • AUTH_CAPTURE
  • CAPTURE_ONLY
  • PRIOR_AUTH_CAPTURE
  • CREDIT

For ECheck and ACH:

  • TEST
  • AUTH_CAPTURE
  • CREDIT

 

Code to use for The CITY Shop

$MerchantData = {
  -GATEWAY_NAME           => 'PaySystems',
  -GATEWAY_BIN_PATH       => '/home/myaccount/cgi-bin/store/jpsclient/bin/run.sh',
};

You will find in the jpsclient package two directories you need to transfer to the store path: bin and lib. In the bin library you will find a batch file and a shell file. The batch file is meant for windows platforms, the shell file for unix platforms. You have to edit the file corresponding to the OS you use, and correct the paths to java and the merchant ID / password. Here is an example of the lines you would change in the file: 

set JAVA_EXE="c:\program files\java\j2sdk1.4.1_05\bin\java"
set JPSCLIENT_HOME="w:\cgi\city\store\jpsclient"
set MERCHANT_CID="12345"
set MERCHANT_PASSWD="mypass"

If you are installing this on an Unix system, you have to chmod 755 the shell file.

You can also host more than one file in that directory, just change the name to something you need (usually the merchant ID).

If you configure this for The CITY Shop, that is all you need to know, and you can return to the installation instructions.

 

Description of the used parameters:

-GATEWAY_BIN_PATH
This is the full path to the batch/shell script that you modified above (Ex: windows platforms): w:/cgi/city/store/jpsclient/bin/run.bat

-LOG_ACTIVITY
This is a flag that you can set on "1" if you want to log the gateway activity

-LOG_FILE_PATH
This is the path where the log file will be created. Note that this is a path only, and the script will create there a file named "PAYSYSTEMS.log"

 

Used fields

Depending on the payment mode, here are the specific required fields:

For the CreditCard and CorporateCard method:

Required Fields for AUTH_CAPTURE and PRIOR_AUTH_CAPTURE:

-ORDER_NUMBER
-ORDER_AMOUNT
-CARD_NUMBER
-CARD_EXPIRES
-CARD_CVV2_NUMBER
-USER_FULL_NAME (or -USER_FIRST_NAME/-USER_LAST_NAME)
-USER_PHONE
-USER_EMAIL
-USER_ADDRESS
-USER_COUNTRY
-USER_ZIP
-USER_CITY

Optional Fields:

-ORDER_CURRENCY
-ORDER_DESCRIPTION
-USER_STATE
-USER_ADDRESS2

Required Fields for CAPTURE_ONLY and CREDIT:

-TRANSACTION_ID
-ORDER_AMOUNT
-ORDER_CURRENCY
-TRANSACTION_DATE (formatted as yyyy-mm-dd)

Optional Fields for CAPTURE_ONLY and CREDIT:

-ORDER_DESCRIPTION

 

For the ACH method:

Required Fields for AUTH_CAPTURE:

-ORDER_NUMBER
-ORDER_AMOUNT
-BANK_ACCT_NUMBER
-BANK_ABA_CODE
-USER_FULL_NAME (or -USER_FIRST_NAME/-USER_LAST_NAME)
-USER_CITY
-USER_STATE
-USER_ZIP
-USER_ADDRESS
-USER_PHONE
-USER_EMAIL

Additionally, one of the following sets are required

-USER_SSN

-USER_MILITARY_ID

-USER_ID_NUMBER
-USER_ID_STATE

Optional Fields for AUTH_CAPTURE:

-ORDER_DESCRIPTION
-USER_ADDRESS2
-USER_ID_COUNTRY
-USER_ID_EXP_YEAR
-USER_ID_NUMBER
-USER_ID_STATE
-USER_ID_TYPE

Required Fields for CREDIT:

-TRANSACTION_ID

 

 

Look in the main install documentation for examples of passing the data to perform a transaction.