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

FirePay

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

 

What you need to start

You receive from FirePay the following authentication data:

  • Merchant ID
  • Merchant Account
  • Merchant Password

 

Gateway Configuration Data

The Firepay product homepage is under: http://www.firepay.com/

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

https://realtime.firepay.com/servlet/DPServlet

For the test mode, the URL is a bit different:

https://realtime.test.firepay.com/servlet/DPServlet



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 only supported payment method is CreditCard

 

Valid values for -ACTION

  • TEST
  • AUTH_CAPTURE
  • PRIOR_AUTH_CAPTURE
  • DELAYED_CAPTURE
  • VOID
  • CREDIT
  • VOID_CREDIT
  • AV_CHECK
  • FAILURE_LOOKUP
  • REQUEST_QUERY

 

Code to use for The CITY Shop

 

$MerchantData = {
  -GATEWAY_NAME           => 'FirePay',
-MERCHANT_ID => '12312312',
-MERCHANT_ACCOUNT => 'merchant',
-MERCHANT_PASSWORD => 'pass',
-GATEWAY_CONNECT_METHOD => 'SubmitLWPUserAgent', # or SubmitNetSSLeay };

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
This is the Merchant ID provided to you by the FirePay.

-MERCHANT_ACCOUNT
This is the Merchant Account provided to you by the FirePay.

-MERCHANT_PASSWORD
This is the Merchant Password provided to you by the FirePay.

-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"

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

 

Used fields

Depending on the action performed action, here are the specific required fields:

For the AUTH_CAPTURE, PRIOR_AUTH_CAPTURE and AV_CHECK methods:

Required Fields:

-CARD_NUMBER
-CARD_EXPIRES
-ORDER_AMOUNT (not required by the AV_CHECK)
-ORDER_NUMBER
-USER_FULL_NAME (or -USER_FIRST_NAME/-USER_LAST_NAME)
-USER_ADDRESS
-USER_CITY
-USER_STATE
-USER_ZIP
-USER_COUNTRY
-USER_PHONE
-USER_EMAIL

Optional Fields:

-ORDER_DESCRIPTION

 

For the DELAYED_CAPTURE method (settlement of PRIOR_AUTH_CAPTURE):

Required Fields:

-ORDER_NUMBER
-TRANSACTION_ID

Optional Fields:

-ORDER_AMOUNT
-ORDER_DESCRIPTION

 

For the VOID method (cancelling of sales/settlements):

Required Fields:

-ORDER_NUMBER
-TRANSACTION_SETTLE_ID (obtained after a sale or delayed capture)

Optional Fields:

-ORDER_AMOUNT
-ORDER_DESCRIPTION

 

For the CREDIT method:

Required Fields:

-ORDER_NUMBER
-TRANSACTION_ID

Optional Fields:

-TRANSACTION_SETTLE_ID (obtained after a sale or delayed capture)
-ORDER_AMOUNT
-ORDER_DESCRIPTION

 

For the CANCEL_CREDIT method:

Required Fields:

-ORDER_NUMBER
-TRANSACTION_SETTLE_ID (obtained after a sale or delayed capture)
-TRANSACTION_CREDIT_ID (obtained after a credit)

 

For the FAILURE_LOOKUP method:

Required Fields:

-ORDER_NUMBER

Optional Fields:

-USER_FULL_NAME (or -USER_FIRST_NAME/-USER_LAST_NAME)
-USER_EMAIL
-TRANSACTION_SEARCH_START_TIME
-TRANSACTION_SEARCH_TIME_WINDOW
The Failure Lookup transaction draws heavily on computing resources, because a number of FirePay transactions must be searched for the matching merchant transaction number. It should, therefore, only be used to recover from failures. The request does allow, however, the merchant to specify the searchStart and searchWindow parameters, which reduces the number of transactions to search, thus accelerating the recovery of the information desired. Merchants should provide this information
whenever possible.

See the online documentation for more info on the parameters required and transaction details.

 

For the REQUEST_QUERY method:

Required Fields:

-ORDER_NUMBER

 


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