AIM Payment Module

Zen Cart AIM Payment Module


  • Account Support Zen Cart by Clicking Here to Sign Up for an Account now

  • CURL is required and MUST be compiled into PHP with TLS/SSL support

  • Your Username and Transaction key (generated in your account area)

  • You need to have HTTPS/SSL active on your site to protect your customers’ sensitive data


You need to generate your username and transaction key:

  1. Log in to your account on the website.

  2. Click on “Account” in the Main Menu Bar.

  3. Click on the “API Login ID and Transaction Key” link under Security settings.

  4. Your username will be shown. Record it.

  5. To generate a new Transaction Key (which is required for new accounts, and also recommended if switching from test mode to production mode), fill in the answer to the security question, and check the box to disable the old key.

  6. Copy and paste your Transaction Key into your Zen Cart settings.


  1. Login to your Zen Cart Admin

  2. Go to Modules

  3. Go to Payment

  4. Select AIM and click Install

  5. Enter your Login ID and Transaction Key as recorded earlier

  6. Configure the rest of the settings as desired:

  7. Transaction Mode Response – Set this to Production for normal use, or simulate some tests using the Test option (See below for testing instructions). NOTE: This can be set to “Test” or “Production” regardless of whether your account is in Test mode.

  8. Authorization Type - In most cases you will want to do an “Authorize+Capture” to capture payment immediately. In some situations, you may prefer to simply “Authorize” transactions, and then manually use your Merchant Terminal to formally capture the payments (esp if payment amounts may fluctuate between placing the order and shipping it)

  9. Enable Database Storage - If you enable this option, extended details of each transaction will be stored, enabling you to more effectively conduct audits of fraudulent activity or even track/match order information between Zen Cart and your records.

  10. Customer Notifications - If enabled, will email a basic receipt to your customers when activity occurs on their card as a result of anything related to transactions you process for them, including purchases as well as refunds.

  11. Merchant Notifications - If enabled, you will also get the emails mentioned above.

  12. Request CVV Number - If enabled, this will cause the customer to be asked for their 3-or-4 digit number off the back of their card. This is important for card validation, and should usually be enabled.

  13. Sort Order of Display – Any value greater than zero will cause this payment method to appear in the specified sort order on the checkout-payment page

  14. Payment Zone - if you want only customers from a particular zone to be able to use this payment module, select that zone here.

  15. Set Completed Order Status - For Captured and Approved orders, what order-status should be set?  Default recommended is “Processing”

  16. Set Refunded Order Status - For transactions that are refunded, this order status setting will be used. Recommended: “Pending”

  17. Debug Mode - If you need to diagnose what details are sent to and received from the gateway, enable this option. Logs will be stored in the /cache folder and numbered in obscurity to prevent snooping. Set it to “Alerts Only” if you want to be emailed if payment system errors occur but not clutter log folders on the server.


You’ll probably find that even for testing you’ll need to have an SSL certificate on your store. Transactions may be rejected if not submitted over SSL.

To test your shop,

  • Set your Transaction Mode to “Test”. You DO NOT need to have your actual account in Testing mode; this will simulate a test even against a Production account.
  • Run a transaction in your shop. 
  • Once satisfied, set the Transaction Mode to ‘Production’



1. Incorporated with each successful order is a listing of:
* generated Order ID
*Approval Code
*Reference Number
*AVS Response
*Fraud Score
*Response Message

The first 3 values should help you cross reference your orders to the system. 
The 4th value AVS (Address Verification System) should help you determine fraud or not.

Still have questions? Use the Search box in the upper right, or try the full list of FAQs. If you can't find it there, head over to the Zen Cart support forum and ask there in the appropriate subforum. In your post, please include your Zen Cart and PHP versions, and a link to your site.

Is there an error or omission on this page? Please post to General Questions on the support forum. Or, if you'd like to open a pull request, just review the guidelines and get started. You can even PR right here.
Last modified April 14, 2022 by Scott C Wilson (30f734e).