User Guide for Odoo Safaricom M-PESA Payment Provider

Odoo Safaricom M-PESA Payment Provider helps businesses accept secure mobile payments through Safaricom M-Pesa during checkout. Customers receive an STK Push request and approve payments directly from their mobile devices.

The module integrates the Safaricom Daraja API with your Odoo website, allowing customers to pay using their registered M-Pesa mobile numbers. It also lets administrators configure payment credentials, process secure payments, and track payment transactions from the backend.

The module supports both sandbox and production environments. Businesses can test payment workflows before accepting live customer payments and monitor transaction records with ease.

• Accept Safaricom M-Pesa payments directly from the website checkout page.
• Send STK Push payment requests automatically to customer mobile devices.
• Configure Daraja API credentials easily from the payment provider settings.
• Support both sandbox and production environments for payment processing.
• Process payments using registered M-Pesa mobile numbers securely.
• Track payment status updates automatically after customer payment authorization.
• Store transaction references securely for payment verification and auditing.
• View complete payment transaction records from a centralized dashboard.
• Monitor customer payment activities and transaction details from the backend.

1. Once you purchase the App from Webkul store, you will receive a link to download module’s zip file.
2. Extract the file on your system after download finishes. As a result, you will be able to see a folder named- ‘wk_safaricom_mpesa_payment’.
3. Copy and paste this folder inside your Odoo Add-Ons path.
4. Now, open the Odoo App and click on the Settings menu. Here, click on Activate Developer Mode.
5. Then, open Apps menu and click on ‘Update Modules List.’
6. In the search bar, remove all the filters and search ‘wk_safaricom_mpesa_payment’.
7. You will be able to see module in the search results. Click on ‘Activate’ to install it.

Configuration of Odoo Safaricom M-PESA Payment Provider

1. First, navigate to Website -> Configuration -> Payment Providers. Then, find Safaricom M-Pesa in the list of available payment providers. Finally, make sure the provider is installed and ready for configuration.

2. Open the Safaricom M-Pesa payment provider and enable it. Select the required environment, enter the Daraja API credentials, Business Shortcode, and Passkey, then save the configuration.

3. First, add the required products to the cart. Then, review the product details, quantity, taxes, and total order amount on the checkout page. Finally, click Checkout to continue with the Safaricom M-Pesa payment process.

4. First, select Safaricom M-Pesa as the payment method. Next, enter a valid M-Pesa mobile number and click Pay Now. Then, an STK Push request is sent to the registered mobile device. Finally, approve the request to complete the payment successfully.

5. After that, the customer is redirected to the order confirmation page after approving the payment request. Then, a success message appears along with the order details, billing information, and payment confirmation status.

6. Navigate to Invoicing > Payment Transactions to view all M-Pesa payment records. Here, you can monitor transaction references, payment methods, customer details, and transaction history from a centralized location.

7. Next, open a payment transaction record to view complete transaction information. Then, review the transaction reference, payment amount, customer details, payment method, provider reference, and transaction status from a single screen.

Hope you find guide helpful! Please feel free to share your feedback in the comments below.

If you still have any issues/queries, please create a ticket at the UV Desk.

I hope this helps. In case of any further queries, contact us at our support mail.

Thanks for paying attention!!