Version: 2.0.0 (6/23/2009)

This page provides a guide for downloading and installing a USAePay payment module for osCommerce. This module has been tested on osCommerce v2.2 RC 2a.


Module Installation

To install the module, download one of the above files and extract the contents. You should end up with two files:


Upload each of these files to its corresponding osCommerce catalog directory on your website. If the files are uploaded correctly you will see USAePay listed under the payment modules menu (see below). For assistance uploading files please consult your web hosting provider.

Module Tutorial

  1. Using your favorite web browser, pull up the administration page of your osCommerce shopping cart. It will look something like the image below:
  2. In the “Modules” area click on “Payment” and you will be brought to your payment modules area:
  3. Toward the bottom of the page you will see USAePay. Click the name and the page will change
  4. Click the “Edit” button to input your USAePay gateway account information
  5. Module values and descriptions
    1. Enable USAePay Module Do you want to accept USAePay payments?
      1. This is the main enable switch, select “True” to activate payment module
    2. Source Key The source key created in USAePay console:
      1. Enter the source key generated from your merchant console at
    3. Source Pin The source pin used to create verify transaction authenticity (must match pin setup in console):
      1. Enter the exact PIN that is in the source editor of your USAePay Merchant Console
    4. Transaction Mode Transaction mode used for processing orders
      1. Select “Test” in order to simulate a transaction without actually processing the card. All fraud and verification checks are performed. Select “Production” to run live transactions
    5. Transaction Method Transaction method used for processing orders
      1. Select “Credit Card” to process Credit Card transactions or Select “eCheck” to process electronic check transactions (ACH)
    6. Queue Transaction Should transactions be queued for your review at USAePay?
      1. Select “True” if you want to authorize credit cards not charge them immediately and see the charges in the queued transactions list of your USAePay Merchant Console. Select “False” for your charges to be immediate and appear in the “Batches” area of your USAePay merchant console.
    7. Credit Card Collection Should the credit card details be collected locally or remotely use the USAePay Payment Form?
      1. Select “PayForm” for USAePay
    8. Customer Notifications Should USAePay e-mail a receipt to the customer?
      1. Select “True” to send receipts or “False” to let your osCommerce shopping cart be the only one to send the receipt
    9. Payment Zone If a zone is selected, only enable this payment method for that zone.
      1. Please consult your osCommerce documentation or leave as “none”
    10. Set Order Status Set the status of orders made with this payment module to this value
      1. Delivered - This status tells the customer that the item has been delivered
      2. Pending - This status tells the customer that the item they purchased is pending
      3. Processed - This status tells the customer that the transaction has been processed
    11. Sort order of display Lowest is displayed first.
      1. If you have more than one payment processor setup this is where you can change the order of what the customer sees on the website
  6. Click “Update” to save the values
  7. Add a product to your cart to see if the USAePay payment module is in place.
  8. Don't forget to turn off test mode in the merchant console's source editor if running a live transaction. For more information on that check the Merchant Console Support section: Support


  ver 2.0.0 -> 2.0.1:
  Fix  function.implode bug
merchant/support/carts/oscommerce.txt · Last modified: 2012/01/12 16:13 by tem

Page Tools