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

Echo Inc.

Echo is an US based company. As of this writing, Echo only supports transactions in US dollars.

 

What you need to start

You receive from Echo Inc. the authentication data as follows:

If your merchant is of type "S":

  • Merchant ECHO-ID
  • Merchant's PIN

If your merchant is of type "F":

  • Merchant ECHO-ID
  • Web-site hosting ISP's ECHO-ID
  • Web-site hosting ISP's PIN

 

Gateway Configuration Data

The Echo Inc. product homepage is under: http://www.echo-inc.com/

This package uses a SSL backlink method to submit the data to the url:

https://wwws.echo-inc.com/scripts/INR200.EXE

You will need the following software installed:

Net::SSLeay v1.15
OpenSSL v0.9.6c

Please check the Net::SSLeay web page for the correct version required:
http://symlabs.com/Net_SSLeay/

For the people that don't have Net::SSLeay installed (NT folks),
there is an alternative submission method using:

LWP::UserAgent
Crypt::SSLeay

Please see the main installation instructions for more information on configuring the SSL modules.

 

Payment Methods

The Supported payment methods are CreditCard, PurchaseCard, ECheck and ACH.

Valid values for -ACTION

For CreditCard and PurchaseCard:

  • TEST
  • AUTH_CAPTURE
  • CAPTURE_ONLY
  • PRIOR_AUTH_CAPTURE
  • CREDIT
  • AV_CHECK
  • SYSTEM_CHECK

For ECheck and ACH:

  • TEST
  • AUTH_CAPTURE
  • CAPTURE_ONLY
  • CREDIT
  • SYSTEM_CHECK

 

Code to use for The CITY Shop

For the "Self" method:

$MerchantData = {
  -GATEWAY_NAME           => 'EchoInc',
  -GATEWAY_VERSION        => 'S',
  -GATEWAY_CONNECT_METHOD => 'SubmitLWPUserAgent', # or SubmitNetSSLeay
  -MERCHANT_ID            => '12345',
  -MERCHANT_PASSWORD      => '...',
  -MERCHANT_NAME          => 'My Shop',
};

For the "Hosted" method:

$MerchantData = {
  -GATEWAY_NAME           => 'EchoInc',
  -GATEWAY_VERSION        => 'F',
  -GATEWAY_CONNECT_METHOD => 'SubmitLWPUserAgent', # or SubmitNetSSLeay
  -MERCHANT_EMAIL         => 'myname@mydomain.com',
  -MERCHANT_ID            => '12345',
  -MERCHANT_ISP_ID        => '12345', 
  -MERCHANT_ISP_PASSWORD  => '...',
  -MERCHANT_NAME          => 'My Shop',
};

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:

-MERCHANT_ID
For merchant types S and F, this is the Merchant's ECHO-ID.

-MERCHANT_PASSWORD
For merchant type S this is the Merchant's PIN. This key is not used by the merchant type F.

-MERCHANT_ISP_ID
For merchant type F, this is the Web-site hosting ISP's ECHO-ID. This key is not used by the merchant type S.

-MERCHANT_ISP_PASSWORD
For merchant type F, this is the Web-site hosting ISP's PIN. This key is not used by the merchant type S.

-MERCHANT_EMAIL
This is the merchant email to use for emailing the order confirmation. It is required by the merchant type F

-GATEWAY_CONNECT_METHOD
This is the same as the key used by the "normal" payment gateways, and points to the method used to connect to the gateway site, in order to finalize the transaction. The allowed values are "SubmitLWPUserAgent" and "SubmitNetSSLeay"

-GATEWAY_AVS_ENABLED
When set, this flag enables Address Verification (AVS) checking, and some extra fields are required in the form input

-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 "ECHOINC.log"

 

Used fields

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

For the CreditCard method:

Required Fields:

-ORDER_AMOUNT
-CARD_NUMBER
-CARD_EXPIRES
-USER_PHONE - required by the payment methods AUTH_CAPTURE and CAPTURE_ONLY
-USER_ADDRESS - required when Address Verification is turned on
-USER_ZIP - required when Address Verification is turned on
-TRANSACTION_ID - required for the payment method PRIOR_AUTH_CAPTURE
-ORDER_NUMBER - required for the payment methods PRIOR_AUTH_CAPTURE and CREDIT

Optional Fields:

-ORDER_TAX
-ORDER_DESCRIPTION
-ORDER_PO_NUMBER
-USER_FULL_NAME (or -USER_FIRST_NAME/-USER_LAST_NAME)
-USER_NAME_PREFIX
-USER_CITY
-USER_STATE
-USER_ZIP
-USER_COUNTRY
-USER_FAX
-USER_EMAIL
-ORDER_PO_NUMBER

-CARD_TRACK1
-CARD_TRACK2
These are Credit card track data which can be read with a physical card terminal.

 

For the ECheck and ACH method:

Required Fields:

-ORDER_AMOUNT
-CHECK_NUMBER
-BANK_ACCT_NUMBER
-BANK_ABA_CODE
-BANK_NAME
-MERCHANT_NAME
-USER_FULL_NAME (or -USER_FIRST_NAME/-USER_LAST_NAME)
-USER_CITY
-USER_STATE
-USER_ZIP
-USER_ADDRESS

Optional Fields:

-ORDER_TAX
-ORDER_DESCRIPTION
-ORDER_PO_NUMBER
-USER_MIDDLE_NAME
-USER_ADDRESS2
-USER_ID_COUNTRY
-USER_ID_EXP_MONTH
-USER_ID_EXP_DAY
-USER_ID_EXP_YEAR
-USER_ID_NUMBER
-USER_ID_STATE
-USER_ID_TYPE


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