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

Innovative Gateway

Innovative Gateway is a US based company. Innovative Gateway supports transactions in US Dollars only.

 

What you need to start

You receive from Innovative Gateway the following information:

  • User ID
  • Merchant ID
  • Password

Note that the Merchant ID is NOT USED for transactions. the UserID is the one used instead.

After you get through with setting an account with them, you have to login in the manager interface, and add the IP address of your server to the list of valid IP's. At the time of this writing, the following was the URL to the manager page:

https://merchants.innovativegateway.com/MERCHGATE_cgi-bin/GatewayMenu.pl

You have to login with your UserID and Password, then go to Security Settings / Set IP's and challenge phrase. You can register there your server IP. The manager interface was rather inconsistent at the time of the writing, after we registered an IP, we could not get to that page again... you will have to call them in a case like that.

The minimum amount allowed for a payment is $2.00. Any order under that amount will be denied.

 

Gateway Configuration Data

The Innovative Gateway product homepage is under: http://innovativegateway.com/

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 and PurchaseCard.

Valid values for -ACTION

For both CreditCard and PurchaseCard:

  • TEST
  • AUTH_CAPTURE
  • CAPTURE_ONLY
  • PRIOR_AUTH_CAPTURE
  • CREDIT
  • VOID

 

Code to use for The CITY Shop

 

$MerchantData = {
  -GATEWAY_NAME      => 'Innovative',
  -MERCHANT_ID       => 'MYCOMPANYNAME123', 
  -MERCHANT_PASSWORD => '98765432', 
  -GATEWAY_CONNECT_METHOD => 'SubmitLWPUserAgent', # or SubmitNetSSLeay
};

This merchant gateway SUPPORTS the form field CCCICNumber. To remind you, this is the 3 digit credit card security number on the back of the card. Also the field CCPhone is required. You can flags this as required in the ShopSetup.pm, as follows:

-SHOP_PAYMENT_DATA_CC_FIELDS_REQUIRED => [qw(CCName CCAddress CCCity          
  CCZip CCState CCCountry CCPhone CCNumber CCExpires CCCICNumber)],

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

...Oh, and make sure your OrderFormVIEW.pm includes the CCPhone field :)

 

Description of the used parameters:

-MERCHANT_ID
This is the UserID provided to you by the gateway.

-MERCHANT_PASSWORD
This is the value of the Password provided to you by the gateway.

-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_EMAIL_MERCHANT
You can set this flag on "1" to enable the gateway to send the merchant a confirmation email.

-GATEWAY_EMAIL_CUSTOMER
You can set this flag on "1" to enable the gateway to send the customer a confirmation email.

-GATEWAY_TEST
You can set this flag on "1" to enable the gateway test mode.

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

 

Used fields

Required Fields:

-ORDER_AMOUNT
-ORDER_NUMBER
-CARD_NUMBER
-CARD_EXPIRES
-USER_FULL_NAME (or -USER_FIRST_NAME/-USER_LAST_NAME)
-USER_ADDRESS
-USER_CITY
-USER_STATE
-USER_ZIP
-USER_COUNTRY
-USER_EMAIL
-USER_PHONE
-CARD_CIC_NUMBER
-TRANSACTION_ID - required for the payment method PRIOR_AUTH_CAPTURE , CREDIT and VOID
 -TRANSACTION_NR - required for the payment method PRIOR_AUTH_CAPTURE , CREDIT and VOID

Optional Fields:

-USER_FAX
-USER_ADDRESS2
-SHIP_ADDRESS
-SHIP_ADDRESS2
-SHIP_CITY
-SHIP_STATE
-SHIP_ZIP
-SHIP_COUNTRY
-SHIP_EMAIL
-SHIP_PHONE
-ORDER_DESCRIPTION

 

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

For the PurchaseCard method:

Required Fields:

-ORDER_PO_NUMBER
-SHIP_ZIP or -USER_ZIP

Optional Fields:

-ORDER_TAXABLE (exempt,non-exempt, or unknown)
-ORDER_TAX
-ORDER_DUTY
-ORDER_SHIPPING

 

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