Payment Restrictions - Magento 2

Firefox user notice:

Please use another web browser to view this document.

Sorry for the inconvenience.

Magento 2 Payment Restrictions enhances native Magento functionality meant to specify payment methods at checkout against a variety of criteria. The extension adds the Customer Group criterion. Now vendors are able to specify which payment methods are to be shown at checkout depending on shopper's belonging to a particular customer group. 

Compatibility: Magento Open Source 2.3.X - 2.4.X, Magento Commerce 2.3.X - 2.4.X

Product Page

Thank you for choosing Aheadworks!

Installing Magento 2 Payment Restrictions

Command Line InstallationComposer Installation

1. Backup your web directory and store database

2. Download the Payment Restrictions installation package

 3. Upload contents of the Payment Restrictions installation package to your store root directory

 4. In SSH console of your server navigate to your store root folder:

cd path_to_the_store_root_folder


php -f bin/magento module:enable Aheadworks_PaymentRestrictions


php -f bin/magento setup:upgrade


php -f bin/magento setup:static-content:deploy

5. Flush store cache; log out from the backend and log in again

Make sure the installation is done from the FTP administrator account. Otherwise, set 775 permissions to the store root directory after the extension is deployed.

If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:

1. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

Run the following command:

composer config repositories.aheadworks composer

On successful execution of the command you will be able to use the composer to install the extensions.

To install the extension:

2. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

 3. Run the following command to install the latest version of the extension:

composer require aheadworks/module-payment-restrictions

if you need to install a specific version, run this command:

composer require aheadworks/module-payment-restrictions:<version>

Specify the version of the extension in <version>

When prompted, enter Public Key (Username) and Private Key (Password):

Both Public Key (Username) and Private Key (Password) can be found in the Composer Access page in your personal account on our site:
Note that the password will not be displayed for security reasons.

4. Enable the extension:

php -f bin/magento module:enable Aheadworks_PaymentRestrictions

Next, register the extension:

bin/magento setup:upgrade

Recompile your Magento store if you are in the Production mode:

bin/magento setup:di:compile

To verify that the extension is enabled, run this command:

bin/magento module:status

Clean store cache, by running the following command:

bin/magento cache:clean

Log out and Log in the backend again.

To upgrade the extension:

5. To update or upgrade an extension:

Download the updated extension file. Take note of the module-name and version. Export the contents to your Magento root.

If a composer package exists for the extension, run one of the following.

Update per module name:
composer update aheadworks/module-payment-restrictions
Updater per version:
composer require aheadworks/module-payment-restrictions:<version>

Run the following commands to upgrade, deploy, and clean the cache.

php bin/magento setup:upgrade --keep-generated
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

Introducing the Magento 2 Payment Restrictions

Payment Restrictions for Magento 2 is a tool to specify payment methods available on the checkout page with regard to the customers' belonging to particular customer groups, as pre-configured on your store.

What is special in Aheadworks Payment Restrictions for Magento 2 in comparison to the native Magento functionality:

  • Payment methods restricted at checkout
  • Customer groups to restrict payment methods
  • All Groups and Multiselect features for customer groups selection
  • Integration with One Step Checkout, Company Accounts

Using Magento 2 Payment Restrictions

The extension comes as a set of similar configuration facilities available at Stores > Configuration > Aheadworks Extensions > Payment Restrictions.

Payment Methods

The page will feature the list of all payment methods, enabled on the store.

To enable/disable payment methods, proceed to Stores > Configuration > Sales > Payment Methods. Should you have any questions regarding the use of thereof refer to the official Magento 2 manual or the instructions of a correspondent payment method/gateway available on the web. For example, if you are using the Bambora APAC extension from Aheadworks, your guide can be accessed here.

Only methods enabled on the store will feature for restricting on the config page of the present extension.


To set restrictions, click the payment method and assign the groups of customers which to your experience will be eligible for this type of payment.

Clicking on the name of the payment method will unfold the full name of thereof, as well as the check-list of all customer groups available on the store. To add/delete customer groups, proceed to Customers > Customer Groups. The official Magento 2 manual will instruct you on how to do that. Name your custom groups meaningfully, so that you later you have meaningful restrictions on payments.

By default all customer groups are given same rights to all payment methods. It means that all payment methods are open for all groups. When in the default mode, the list of groups will come inactive, greyed-out, and the Use System value checkbox checked.

To specify the groups which will have access to the chosen payment method, untick the Use System Value checkbox and click on the customer group on the list. The multiselect feature is available in the extension: select the group, press the CTRL button on the keyboard, hold it and select as many other groups as you need. Multiselect works with your mouse and mobile devices too.

The All Groups option will apply restrictions to all groups presented on the list.

Sample restrictions:

B2C customers will be thankful for their ever favorite credit/debit cards or payment gateways. B2B clients, in turn, will appreciate bank transfers or letters of credit.

Only those methods of payment which were pre-configured for display with the present extension will feature on the Checkout page. This will save time of customers, and furthermore suggest them you know their needs and preferences.


The Magento 2 Company Accounts module allows creating company accounts and assigning them to particular customer groups. Those will be your B2B clients, and thereby they may well need specific payment methods, different to those of general customers. 

The Magento 2 One Step Checkout extension enhances the native Magento checkout functionality for best user experience. It will feature the specified for the customer payment methods in its usual, enhanced, way.

Uninstalling Payment Restrictions

Manual Removal

1. Disable the module by executing the following commands:

php bin/magento module:disable Aheadworks_PaymentRestrictions
php bin/magento setup:upgrade

2. Remove the extension files from the following folder:


Automatic Removal (via Composer)

1. Disable the module by executing the following commands:

php bin/magento module:uninstall Aheadworks_PaymentRestrictions

Product Page

Need Customization?

You can always find the latest version of the software, full documentation, demos, screenshots, and reviews on
License agreement:
Contact Us:
Copyright © 2021 Aheadworks Co.