Disable a Payment Method Programmatically in Magento 2

Payment system management can be considered as one of the cores of the Magento 2 store system as a good handling system can help you optimize your sales, profits as well as your efforts.

Sometimes, you will want to restrict specific payment methods based on the customer groups, product/order attributes, shipping parameters, etc. In other words, it’s time when you can programmatically disable a payment method from your Magento 2 backend configuration. For example, with customers who are coming from India, you can deactivate other payment methods and only display the CCAvenue method.

In today’s article, I will show you 2 simple stages to disable payment method programmatically in Magento 2.

2 Steps to Disable a Payment Method Programmically in Magento 2:

• Step 1: Edit config.xml file
• Step 2: Edit Observer.php file

Step 1: Edit config.xml file

To disable the Payment Method Programmatically, firstly, you need to open the app/code/Vendor/Module/etc/events.xml file and then add the following code to that file:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="payment_method_is_active">
        <observer name="disable_payment_method" instance="Vendor\Module\Observer\DisablePaymentMethod" />
    </event>
</config>

Step 2: Edit Observer.php file

In this step, the below code should be added in the app/code/Vendor/Module/Observer/DisablePaymentMethod.php file

<?php

namespace Vendor\Module\Observer;

use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
use Magento\Checkout\Model\Session as CheckoutSession;

class DisablePaymentMethod implements ObserverInterface
{
    protected $checkoutSession;

    public function __construct(
        CheckoutSession $checkoutSession
    ) {
        $this->checkoutSession = $checkoutSession;
    }

    public function execute(Observer $observer)
    {
        $paymentMethod = $observer->getEvent()->getMethodInstance();
        $result = $observer->getEvent()->getResult();
        $result->setData('is_available', false);
    }
}

Related Post:

• How to Add Product Attribute Programmatically in Magento 2?
• How to Create Invoice Programmatically in Magento 2?
• How to Create Customer Programmatically in Magento 2?

Conclusion

That’s all about how to disable a Payment Method Programmically. Implement these stages correctly, you can control the payment methods choices at your checkout page according to different conditions. For the full solution to restrict payment choices, you can view Mageplaza Payment Restrictions module.

I hope this tutorial is helpful for you. If you have any question about this topic or face any issue while following the steps, feel free to let me know.

Thanks for reading!