Magento is a popular opensource ecommerce platform that represents the next generation in shopping carts, ecommerce technology and web standards. The “Community Edition” can be downloaded for free. For those who need enterprise features and support, a commercial Enterprise Edition is also available.
USAePay maintains and supports a payment gateway extension for Magento 1.7 or later. This page contains instructions for installation of the module, a guide to the configuration options and troubleshooting assistance.
Additional information is also available on our Magento Connect page.
The easiest way to install the module is to use the Magento Connect Manager. This is located under System - Magento Connect menu within your Magento admin area:
Paste the extension key 'http://connect20.magentocommerce.com/community/Mage_Usaepay-1.1.9' into the appropriate field and click on the “Install” button:
Once the install is complete you should be able to return to the admin console. If installation was successful you should now see USAePay listed in the Payment Methods section of the configuration screen. You can find this by going to the System menu and choosing “Configuration.” The Payment Methods section is listed under “Sales.”
If you do not see USAePay in the list of Payment Methods, it is possible that this screen is cached. Try clicking the “Save Config” button in the top right corner to refresh the screen.
If for some reason you are not able to use Magento Connect, you can manually upload the plugin files to your magento folder via FTP.
Start by downloading the USAePay Magento plugin:
Once downloaded, unzip/unpack the file. You should now have a folder called Mage_Usaepay-126.96.36.199:
These files must be uploaded into the same folders within your magento folder on your webserver. If you are not familiar with how to upload files to your website, please contact your web hosting provider.
Once these files are uploaded you should be able to log into your magento admin console. If installation was successful you should now see USAePay listed in the Payment Methods section of the configuration screen. You can find this by going to the System menu and choosing “Configuration.” The Payment Methods section is listed under “Sales.”
If you do not see USAePay listed in the list of Payment Methods, it is possible that this screen is cached. Try clicking the “Save Config” button in the top right corner to refresh the screen.
If something goes wrong and your site is no longer operational, use your FTP program to remove the “app/etc/modules/Mage_Usaepay.xml” file. This will disable the USAePay extension.
To configure the module go to the System menu and choose “Configuration.” Then click on “Payment Methods” listed under the Sales section of the left hand bar. Then click on “USAePay.” You should then see a config screen that looks like:
To enable the USAePay module:
You should now be able to process credit cards via your USAePay account.
Select 'Authorize and Capture“ to make an immediate charge. Select 'Authorize Only' to authorize the card and then manually settle the funds at a later time (such as during shipping).
Select a title for this Payment Option such as 'Secure Credit Card' or 'USAePay'.
Please enter your USA ePay Source Key. Input your source key generated from your USAePay merchant console
Enter a pin, if applicable.
Enter a description that will appear on all transactions or use #[orderid] to display the order ID.
Unless you have a Multi-Currency gateway account this is always US Dollars.
Select the status that will appear on all new orders.
Select “No” to send transactions to your main USAePay account. Select “Yes” to send transactions to a “sandbox” test environment.
If you have multiple payment options enter 1 to have this payment module be first.
If you accept payments from all countries select this option or select Specific and the next section will be active.
Select specific countries to accept payment from.
Enter the dollar amount for a minimum order.
Enter the dollar amount for a maximum order.
The module installs its template file into the default template directory only. If you have created a custom template, you will most likely get an error using our extension. The error should look something like:
Warning: Mage_Core_Block_Template::include (.../app/design/frontend/YOURTEMPLATE/default/template/usaepay/form.phtml) [mage-core-block-template.include]: failed to open stream: No such file or directory in .../app/code/core/Mage/Core/Block/Template.php on line 144
If you get this error, copy the folder app/design/frontend/default/default/template/usaepay/ to app/design/frontend/YOURTEMPLATE/default/template/usaepay where YOURTEMPLATE is the name of your custom template.
It is not a full error message. To show the underlying curl error you can change the following line:
Mage::throwException(Mage::helper('paygate') ->('Payment authorization error: ' . $tran->error . '('.$tran->errorcode . ')'));
Mage::throwException(Mage::helper('paygate') ->('Payment authorization error: ' . $tran->error . '('.$tran->errorcode . ') ' . $tran->transporterror));
Payment authorization error: Error reading from card processing gateway.(10132)SSL certificate problem, verify that the CA cert is OK. Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed
$bundle = dirname(__FILE__) . '/curl-ca-bundle.crt'; $tran->cabundle = $bundle;