Magento 2 C2B M-Pesa Payment

Magento 2 C2B M-Pesa Payment integrates C2B M-PESA API with Magento 2 to allow customers to pay using their phone securely in the store.

 

Table of Content

  1. Extension Installation
  2. Configuration
  3. C2B M-Pesa Payment Method in Frontend
  4. C2B M-Pesa Payment Details in Backend

           

  1. Extension Installation
  • For Magento Marketplace Customers
    • Create a folder structure in Magento root as app/code/Meetanshi/Mpesa
    • Download and extract the zip folder and upload our extension files to the app/code/Meetanshi/Mpesa via FTP.
    • Login to your SSH and run below commands step by step:
      • php bin/magento setup:upgrade
      • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
      • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
      • php bin/magento cache:flush
         
  • For Meetanshi Customers
    • Extract the zip folder and upload our extension to the root of your Magento 2 directory via FTP.
    • Login to your SSH and run below commands step by step:
      • php bin/magento setup:upgrade
      • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
      • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
      • php bin/magento cache:flush

 

  1. Configuration
    For configuring the extension, log in to Magento 2, move to Sales > Payments Methods à C2B M-Pesa Payment - Meetanshi where you can find various settings to enable the extension.
  • Enabled: Set “YES” to enable the payment method.
  • Title: Set the title of the payment method to be displayed in the frontend.
  • Show M-Pesa Logo: Set YES to show M-Pesa logo along with the payment method in the frontend.
  • Sandbox Mode: Select YES to enable sandbox mode.
  • ShortCode: Enter Shortcode provided by M-Pesa while registration with Safaricom.
    • Login to Safaricom and move to credentials where you can find the C2B M-Pesa Online ShortCode.

 

  • Consumer Key: Enter consumer key provided by M-Pesa while registration with Safaricom.
  • Consumer Secret: Enter consumer secret provided by M-Pesa while registration with Safaricom.
    • Login to Safaricom and move to My Apps. Select your app and click on the “Keys” tab where you can find both the consumer key and consumer secret.

 

  • URL for Request Payment: Payment request URL will be pre-filled on extension installation.
  • Access Token URL: Access token URL will be pre-filled on extension installation.
  • Register URL: Register URL will be pre-filled on extension installation.
  • Payment from Applicable Countries: Select countries to allow using this payment method.
  • Debug: Select YES to enable debug.
  • Instructions: Enter instructions to show along with the payment method in the frontend.
  • Sort Order: Enter Sort Order of the payment method display in the frontend.

 

 

 

  1. C2B M-Pesa Payment Method in Frontend
    Once the payment method is configured, C2B M-Pesa Payment method is shown on the checkout page in the frontend while checking out the products. Just select the C2B M-Pesa Payment method, add M-Pesa mobile number and click “Place Order” to place order.

 

  • C2B M-Pesa Payment Confirmation on Order Success
    Once the order is placed, follow the instructions on the order success page to confirm the payment.

 

  • C2B M-Pesa Payment Details in “My Account” section
    Once the order is placed, the C2B M-Pesa Payment details are shown in the Account dashboard, in “My Orders” tab which includes payment method name, transaction ID, transaction time, and Mpesa number.

 

  1. C2B M-Pesa Payment Details in Backend
    Apart from the frontend, the admin can also view C2B M-Pesa Payment details in the Sales > Orders > Order View section in the backend. It displays the payment details like payment method name, transaction ID, transaction time, and Mpesa number.