What is Magento? 

Magento is an eCommerce platform built on an open source technology that provides online merchants with a flexible shopping cart system, as well as control over the look, content, and the functionality of their online store. Magento offers powerful marketing, search engine optimization, and catalog-management tools.

 How to integrate your Magento platform with your PayTabs account? 

By following the below steps, you will integrate your system in no time, and without even needing a technical background.

Installing the Plugin

  1. Log in to your merchant dashboard. 
  2. Navigate to the Developers menu.
  3. Go to Magento under the “PRE-BUILT INTEGRATIONS” section. 
  4. Click on the link “click here” as shown in the picture below. 

  5. Then use one of the following methods to install the plugin:


  1. Upload your downloaded plugin from step 4 to the "<root>/app/code" directory within your Magento installation directory.

  2. Extract the plugin file.

    Graphical user interface, text, application 
Description automatically generated

Activating the Plugin

You can activate your plugin by running  the following Magento commands:

php bin/magento setup:upgrade 

php bin/magento setup:static-content:deploy 

php bin/magento cache:clean 

Then by default, the module will be activated. In case you want to Disable/Enable the module just follow the below steps: 


php bin/magento module:enable PayTabs_PayPage 


php bin/magento module:disable PayTabs_PayPage 


Configure the Plugin

  1. From your Magento admin panel, navigate to Stores > Configurations
  2. Go to the tab “Sales” > Payment Methods

  3. Select the preferred payment method from the listed available PayTabs payment methods.

  4. Enable the payment method by choosing the "Yes" option

  5. Choose your Paytabs endpoint region (the region your Paytabs account registered at)

  6. Enter your "Profile ID" and "Server Key" in the account information section on your configuration page. For more information about how to get your integration keys from your dashboard, please click here

  7. Click on the “Save Config” button to save your configurations. 

And here you are done installing PayTabs latest Magento plugin, and you can run on the ground with your business. 

How to upgrade the PayTabs plugin in Magento to the latest version?

  1. Go to your Magento admin panel and deactivate the old payment plugin, you already using for now.
    php bin/magento module:disable PayTabs_PayPage 

  2. Then Delete the uploaded Magento folder in your root directory.
  3. Repeat the above steps on the "How to integrate your Magento platform with your PayTabs account?" section.

How to know that you are using an old Magento plugin (PT1)? 

After logging in to your WooCommerce account, navigate to the PayTabs plugin. Usually, you will see Merchant email and secret key instead of profile id and server key, which was the old way of authenticating, and it’s deprecated and no longer used anymore.


What are Paytabs plugin configuration options? 

Enable Option 

In case you want to enable/disable the payment method on the checkout page for your customers.

Title Option 

In case you want to change the payment method title that is displayed on the checkout page for your customers, you may change it.


iFrame mode Option 

This option enables you to display Paytabs payment page as apart from (within) the checkout page, without needing to redirect the customer outside your website and redirect him back again.


Payment Currency Option 

This is an option that controls what the payment currency would be on the checkout page, whether the base currency of your website or the order currency selected from your customer.

We highly prefer to use the base currency option as Magento will convert the ammount depnds on the selected order currency, which may differ from the exchange rate then.

Successful Payment Order Status Option 

This option controls what will be the order status on your system after it has been completed (authenticated/successful payment).

Be very careful when you change the Default option. Once you change it, you change the normal flow of the Order into the Magento system, you may encounter some consequences based on the new value you set 


Failed To Pay Order Status Option 

This option controls will be the order status on your system if it's failed on the payment phase (declined/error/not a successful payment) 

Be very careful when you change the Default option. Once you change it, you change the normal flow of the Order into the Magento system, you may encounter some consequences based on the new value you set 

Re-Fill The Cart if Payment Failed Option 

If you want your customer's cart to be re-filled in case of the payment has failed, mark this option as Yes to save your customer's efforts to re-fill it.


Order Confirmation Email Option 

This option allows the merchant to use whether Magento default behavior *, or stop sending confirmation emails at all and depending on the invoice one, or finally, send the confirmation email only if the payment is authenticated and succeeds.

Once the customer hits the place the order button, Magento will create the order already (at this point the customer can see this order in his account), then after that Magento redirects the customer to the payment page (default system flow). In other words, Magento creates the order already whether it has been paid or not (payments only affect the order status). 

Magento sends a confirmation email to the customers once the order has been placed as a confirmation email, and another one once the payment is authenticated and succeed as an invoice email, which may confuse some customers/merchants.

Hide shipping Information Option 

In case you want to not force the customers to reenter both billing and shipping information, you may like to enable it.

The customer details are still required and must be passed, in case any of the details are missing or passed with invalid values; the hide_shipping option will be ignored and cardholder will be required to enter any of the missing details on the payment page

Enable Tokenize Option 

In case you want to display the “Save to account”  button to allow your customer to save their payment methods for later use without navigating to Paytabs payment page, this is used for subscriptions purposes.

Customer cards will not be saved if the payment faild, only a successfull payment should save the card to the account.

Sort Order Option 

This option controls the payment method sorting order on the checkout page.

Payment Action Option 

This option is not supported for all payment methods, it controls whether the transaction type is sale or auth.

Sale: Directly deduct the payment from the customer's bank account, credited to the merchant account. 

Authorize: will be Authorized (hold) only on customer's account to be captured later.

Authorized orders can be fully/partialy captured manually either from Magento admin panels > Sales > Orders > [Selected Order] > Invoice > Catpture.

Or manually as well, but from the merchant's Paytabs dashboard.

Same for refunding/releasing this authorized amount back to the customer (fully and partially).

How to find log files to troubleshoot any issues?

In some cases, when you contact our technical support team for assistance, they require the log file to assist you accordingly (or even you may want to troubleshoot the plugin behavior yourself), you will be able to find those files at:

PayTabs custom log

It will be named as debug_paytabs.log file and will be found at /var/log/debug_paytabs.log