Magento 2: Get Payment Methods (All/Active/Used)

Facebook Tweet LinkedIn Pin Print EmailShares

This article shows how to get payment methods in Magento 2. We will be fetching 3 types of payment methods. They are:

1) All Payment Methods
2) Active/Enabled Payment Methods
3) Payment Methods that have been used while placing orders

I will be showing both ways (Dependency Injection & Object Manager way) to get payment methods.

Using Dependency Injection (DI)

Here is the code that you need to write in your Block class.


/**
 * Order Payment
 *
 * @var \Magento\Sales\Model\ResourceModel\Order\Payment\Collection
 */
protected $_orderPayment;

/**
 * Payment Helper Data
 *
 * @var \Magento\Payment\Helper\Data
 */
protected $_paymentHelper;

/**
 * Payment Model Config
 *
 * @var \Magento\Payment\Model\Config
 */
protected $_paymentConfig;

/**
 * @param \Magento\Backend\Block\Template\Context $context
 * @param \Magento\Sales\Model\ResourceModel\Order\Payment\Collection $orderPayment
 * @param \Magento\Payment\Helper\Data $paymentHelper
 * @param \Magento\Payment\Model\Config $paymentConfig
 * @param array $data
 */
public function __construct(
	\Magento\Backend\Block\Template\Context $context,
	\Magento\Sales\Model\ResourceModel\Order\Payment\Collection $orderPayment,
	\Magento\Payment\Helper\Data $paymentHelper,
	\Magento\Payment\Model\Config $paymentConfig,
	array $data = []
) {
	$this->_orderPayment = $orderPayment;
	$this->_paymentHelper = $paymentHelper;
	$this->_paymentConfig = $paymentConfig;
	parent::__construct($context, $data);
}

/**
 * Get all payment methods
 * 
 * @return array
 */ 
public function getAllPaymentMethods() 
{
	return $this->_paymentHelper->getPaymentMethods();
}

/**
 * Get key-value pair of all payment methods
 * key = method code & value = method name
 * 
 * @return array
 */ 
public function getAllPaymentMethodsList() 
{
	return $this->_paymentHelper->getPaymentMethodList();
}

/**
 * Get active/enabled payment methods
 * 
 * @return array
 */ 
public function getActivePaymentMethods() 
{
	return $this->_paymentConfig->getActiveMethods();
}

/**
 * Get payment methods that have been used for orders
 * 
 * @return array
 */ 
public function getUsedPaymentMethods() 
{
	$collection = $this->_orderPayment;
	$collection->getSelect()->group('method');
	$paymentMethods[] = array('value' => '', 'label' => 'Any');
	foreach ($collection as $col) { 
		$paymentMethods[] = array('value' => $col->getMethod(), 'label' => $col->getAdditionalInformation()['method_title']);			
	}		
	return $paymentMethods;
}

Using Object Manager


$objectManager =  \Magento\Framework\App\ObjectManager::getInstance();		

$paymentHelper = $objectManager->get('Magento\Payment\Helper\Data');
$allPaymentMethods = $paymentHelper->getPaymentMethods();
$allPaymentMethodsArray = $paymentHelper->getPaymentMethodList();

var_dump($allPaymentMethodsArray);
var_dump($allPaymentMethods);

$paymentConfig = $objectManager->get('Magento\Payment\Model\Config');
$activePaymentMethods = $paymentConfig->getActiveMethods();

var_dump(array_keys($activePaymentMethods));

$orderPaymentCollection = $objectManager->get('\Magento\Sales\Model\ResourceModel\Order\Payment\Collection');
$orderPaymentCollection->getSelect()->group('method');
$paymentMethods[] = array('value' => '', 'label' => 'Any');
foreach ($orderPaymentCollection as $col) { 
	$paymentMethods[] = array('value' => $col->getMethod(), 'label' => $col->getAdditionalInformation()['method_title']);            
}        

var_dump($paymentMethods);

Sample Output of getUsedPaymentMethods():


Array
(
    [0] => Array
        (
            [value] => 
            [label] => Any
        )

    [1] => Array
        (
            [value] => cashondelivery
            [label] => Cash On Delivery
        )

    [2] => Array
        (
            [value] => checkmo
            [label] => Check / Money order
        )

)

Sample Output of getAllPaymentMethodsList():


Array
(
    [vault] => 
    [substitution] => 
    [banktransfer] => Bank Transfer Payment
    [cashondelivery] => Cash On Delivery
    [checkmo] => Check / Money order
    [payflowpro] => Credit Card
    [payflow_link] => Credit Card
    [payflow_advanced] => Credit Card
    [braintree] => Credit Card (Braintree)
    [authorizenet_directpost] => Credit Card Direct Post (Authorize.net)
    [free] => No Payment Information Required
    [braintree_paypal] => PayPal (Braintree)
    [paypal_billing_agreement] => PayPal Billing Agreement
    [payflow_express_bml] => PayPal Credit
    [paypal_express_bml] => PayPal Credit
    [paypal_express] => PayPal Express Checkout
    [payflow_express] => PayPal Express Checkout Payflow Edition
    [hosted_pro] => Payment by cards or by PayPal account
    [purchaseorder] => Purchase Order
    [braintree_cc_vault] => Stored Cards (Braintree)
    [payflowpro_cc_vault] => Stored Cards (Payflow Pro)
)

Sample Output of getAllPaymentMethods():

The output array of of getActivePaymentMethods() is very long. So, I have just printed out the keys of the array. Keys of the output array contains active method’s code.

Sample Output of array_keys(getActivePaymentMethods()):


Array
(
    [0] => free
    [1] => checkmo
    [2] => purchaseorder
    [3] => cashondelivery
    [4] => paypal_billing_agreement
)

Hope this helps. Thanks.

Related posts: