OpenCart Plugin | CatalystPay

OpenCart
Plugin
Installation
and
Configuration
Manual

Download Version 3 Download Version 4

Installation steps

 

Step 1: Downloading the Plugin

Download the CatalystPay plugin tailored for your specific OpenCart version. Ensure compatibility with either 4.X.X or 3.X.X.

Step 1: Downloading the Plugin

Step 2: Access Your OpenCart Admin Panel

Log in to your OpenCart admin panel. The default URL is typically https://yourdomain.com/admin. Note that you might have personalized this URL for enhanced security.

Step 2: Access Your OpenCart Admin Panel

Step 3: Navigate to Extensions > Installer

In the main menu, find and click on "Extensions." Then, from the dropdown, select "Installer" to initiate the plugin integration process.

Step 3: Navigate to Extensions > Installer

Step 4: Upload the Plugin ZIP File

Within the Installer section, locate and click the "Upload" button. Select the previously downloaded ZIP file of the CatalystPay plugin.

Step 4: Upload the Plugin ZIP File

Step 5: Initiate Installation

After selecting the plugin's ZIP file, proceed by clicking the "Continue" button. This action initiates the installation procedure, ensuring the plugin becomes an integral part of your OpenCart setup.

Step 5: Initiate Installation

Step 6: Enable the Plugin

Once the installation is successfully completed, it's time to enable the plugin. Revisit the "Extensions" section in the main menu, then navigate to "Extensions" again. This time, specifically select "Payments" as the extension type. Among the displayed payment options, locate the CatalystPay plugin and activate it. This is achieved by clicking on the "Install" button associated with the CatalystPay plugin.

Step 6: Enable the Plugin
 
 

Configuration

 

Step 1: Enter the General Configuration Menu

Navigate to Extensions>Extensions and click edit next to the CatalystPay extension.

Step 1: Enter the General Configuration Menu

Step 2: General Configuration Setup

Once we set up your Production or Test account with our gateway, you'll receive a welcome letter including your API credentials to enter into the general configuration tab. This step is crucial for a seamless integration of our services. During this process, make sure to have the plugin installed in your OpenCart environment to facilitate the setup

 

  • API Merchant: Enter your API username, which acts as the identity for your merchant account in requests.

  • API Channel: Add your API channel, often the same as your merchant API parameter, to enable multiple payment types like ApplePay and GooglePay.

  • API Token: Insert your verification token to authenticate your merchant account.

  • API Secret: Include the secret code for the notification URL to ensure secure communication.

  • Title: Customize the payment type's visible title for your consumers, such as "Debit/Credit Card."

  • Status: Choose between enabling or disabling the payment method.

  • Preauthorization: Opt for preauthorization to temporarily reserve funds upon order placement, releasing them if not captured within a certain timeframe.

  • GooglePay: Enable GooglePay for a seamless payment experience, requiring prior registration with Google.

  • ApplePay: Enable ApplePay for swift transactions, requiring prior registration with Apple's developer center.

  • Test Mode: Easily switch between sending requests to Production or Test environments, each with distinct credentials.

  • Debug Logging: During testing, activate this option to store valuable transaction logs within your OpenCart store.

  • Geo Zone: Decide where the payment option is accessible; select "All Zones" or specific zones as needed.

Step 2: General Configuration Setup

Step 3: Order Status Mapping

In this section, you have the flexibility to match notification statuses with the preferred order statuses in your shopping cart environment. Our default configuration provides a smooth setup, which you can stick with or modify according to your needs.

Step 3: Order Status Mapping
 
 

How to manage transactions

 

Step 1: Completed Integration and Setup

Having completed the configuration process outlined earlier, your consumers are now empowered to initiate payments through the CatalystPay plugin.

 

Step 2: Automated Order Generation

Upon a consumer's successful transaction using the plugin, an order will be seamlessly created within your "Orders" menu (located at Home > Orders). This order will be accompanied by the appropriate status, reflecting the transaction's progress.

Step 2: Automated Order Generation

 

Step 3: In-Depth Order Exploration

Adjacent to each order, an action button labeled "View" will be at your disposal. By selecting this button, you'll unlock a portal to delve into comprehensive details pertinent to the specific order.

Step 3: In-Depth Order Exploration

 

Step 4: Transaction Chronicles in the History Tab

Upon accessing the order details, a "History" tab emerges, offering a chronological compilation of notifications dispatched from the gateway. These notifications serve as a record of the transaction's evolution, delineating when and how status modifications were enacted.

Step 4: Transaction Chronicles in the History Tab

 

Step 5: Manual Transaction Adjustment (Exercised Prudently)

While CatalystPay's automated framework is robust, there exists an option for manual transaction modification. However, this avenue is recommended only under specialized technical circumstances. Ordinarily, the transaction status undergoes automatic adjustments in response to gateway notifications. Manual intervention is presented as a safeguard against potential misconfigurations.

Step 5: Manual Transaction Adjustment (Exercised Prudently)

 

Step 6: Seamlessly Orchestrated Refund

In situations necessitating a refund, refer to the order's history menu. Within this interface, identify the transaction's unique ID from the notifications archive. This ID serves as the key to locate the transaction within the gateway's administrative portal. Once located, exercise the "Actions" menu to initiate a refund. This action triggers a new notification to be dispatched to your OpenCart, consequently updating the transaction's status to "Refunded" (unless altered within the plugin's configuration settings).

Step 6: Seamlessly Orchestrated Refund

 

Step 7: Harmonizing Transaction Status

Each alteration in a transaction's status, orchestrated within the gateway, initiates a parallel notification to be dispatched to your OpenCart. This intricate synchronization ensures the automatic adjustment of order statuses, furnishing your customers with a seamlessly integrated experience.

Step 7: Harmonizing Transaction Status
 
 

Download Version 3 Download Version 4