M-Pesa
Configure and manage M-Pesa payment method
M-Pesa
M-Pesa is a leading mobile money service that enables users to store and transfer money, pay for goods and services, and access financial services using their mobile phones. By integrating M-Pesa with PayOS, businesses can offer a secure and convenient payment option to their customers, facilitating real-time transactions and enhancing the overall payment experience.
Introduction
M-Pesa, a mobile money service launched in 2007 by Safaricom and Vodacom, operates primarily in several African countries. It is an essential payment method for businesses targeting markets in Africa where mobile money services are extensively used. Integrating M-Pesa with PayOS allows you to accept payments, initiate transfers, and manage financial transactions efficiently. This guide provides a comprehensive overview of how to integrate M-Pesa into your application or website using PayOS.
M-Pesa’s extensive agent network and user-friendly platform have made it a significant player in promoting financial inclusion across these regions, serving millions of customers who may not have access to traditional banking services. In addition to its primary operations, M-Pesa has expanded its services to include international transfers, enhancing its functionality beyond just domestic transactions. Notably, users in Kenya can send money to countries such as Rwanda, Uganda, Botswana, Zambia, Malawi, Bangladesh, Pakistan, and Burundi.
Pre-requisites
Before accepting M-Pesa payments through PayOS, ensure you meet the following requirements:
-
PayOS Integration:
You have integrated with PayOS, either using our hosted checkout, SDK, or server-to-server API. -
Payment Processor Configuration:
You have set up an integration account for M-Pesa with supported Payment Service Providers (PSPs) in PayOS. Ensure that the commercial relationships with these PSPs are in place or can be utilized through PayOS. -
Enable M-Pesa:
You have enabled M-Pesa as a payment option in your PayOS configuration through the PayOS Portal. -
Meta Fields Setup:
If M-Pesa requires specific meta fields (such as mobile number or transaction reference), ensure these fields are correctly configured underMerchant configurations -> Meta fields
on your PayOS dashboard and included in your requests.
Ways to Integrate M-Pesa with PayOS
PayOS supports multiple integration methods for offering M-Pesa at checkout:
-
PayOS Hosted Checkout
Using PayOS’s hosted checkout is the simplest way to accept M-Pesa payments. With this option:- Minimal development is required on your end.
- PayOS automatically displays the M-Pesa payment method during checkout.
- You can control the payment methods offered through the session creation API call, specifying M-Pesa as a restricted method if desired.
-
PayOS SDK
If you prefer more control over your checkout experience, you can integrate with the PayOS SDK:- The SDK provides UI components to include M-Pesa as a payment method seamlessly.
- It simplifies capturing any required inputs (like mobile number) and initiating transactions without extensive server-side coding.
- Consult the PayOS SDK documentation for detailed steps on integrating M-Pesa.
-
Server-to-Server Integration
For complete control over your payment process and checkout flow, you can integrate M-Pesa using PayOS’s server-to-server APIs:- This approach offers greater flexibility in implementing the payment flow and handling customer data.
- You will be responsible for capturing necessary inputs (e.g., mobile number) and forwarding them to PayOS securely.
Let’s explore the server-to-server approach in more detail.
Retrieving Available Payment Methods
Using the PayOS API, you can retrieve a list of available payment methods for a given checkout session by calling the GET /v1/payment/available-methods
endpoint with a sessionId
. For M-Pesa, the method type is typically returned as mobileMoneyMPesa
.
Request:
Response:
In this response:
- The M-Pesa payment method is listed with
"type": "mobileMoneyMPesa"
. - The
requiredInput
field indicates that the customer must provide details such as their mobile number and transaction reference.
Creating a Checkout Session
To create a checkout session that includes M-Pesa as a payment option, make a POST request to the /v1/checkout/session
endpoint. You can specify which payment methods to offer in the paymentMethods
array. For M-Pesa, set "type": "mobileMoneyMPesa"
.
Response:
In this example:
- The
paymentMethods
array restricts the session to only the M-Pesa payment method ("type": "mobileMoneyMPesa"
). restrict
set totrue
ensures that this session provides only M-Pesa as the available payment method.- The
sessionId
in the response references this specific checkout session, which can be used to retrieve available methods, complete the payment, or make further adjustments before checkout completion.
Handling the Payment
After creating a session, your application can direct customers to the paymentLink
if using the hosted checkout. If you’re using the PayOS SDK or a server-to-server integration, you’ll use the session details to process the M-Pesa payment. This involves:
-
Initiating M-Pesa Payments:
Follow these steps to initiate an M-Pesa payment:-
Collect the Required Details:
Gather the customer’s mobile number and transaction reference. -
Send the Payment Request:
Send aPOST /merchant/v2/payments/
request to the Wallet Platform with the required information. -
Handle the Approval Process:
Inform the customer to approve the payment using their M-Pesa client (e.g., mobile app or USSD).
-
-
Verifying Payment Status:
You can verify the status of the payment in several ways:- Polling: Use the transfer status endpoint to check the payment status.
- Webhooks: If you have webhooks enabled, monitor the payment status through webhook notifications.
- Callback URLs: For payments with
callback_id
, PayOS will send the payment details and status to the specified callback URL.
Supported Regions / Countries
M-Pesa, a mobile money service launched in 2007 by Safaricom and Vodacom, operates primarily in several African countries. Here is a list of the countries where M-Pesa is currently available:
- Kenya
- Tanzania
- Mozambique
- Democratic Republic of Congo (DRC)
- Lesotho
- Ghana
- Egypt
In addition to these, M-PESA has expanded its services to include international transfers to and from various countries, enhancing its functionality beyond just domestic transactions. Notably, users in Kenya can send money to countries such as Rwanda, Uganda, Botswana, Zambia, Malawi, Bangladesh, Pakistan, and Burundi.
Supported Currencies
(Note: Support for additional regions and countries may be added in the future. Check PayOS documentation or contact support for updates.)
Supported Workflows and Services
The following table outlines the workflows and services supported when using M-Pesa with PayOS:
Ensuring a Seamless and Secure Payment Experience
To optimize your integration and ensure customer satisfaction, consider the following best practices:
-
Prioritize Security and Compliance:
Protecting customer data is paramount. PayOS adheres to PCI DSS standards and other relevant regulations. Ensure you also follow any additional region-specific compliance requirements, especially when handling sensitive financial information across different countries. -
Focus on a Smooth User Experience:
Present payment methods clearly and intuitively. When customers reach the checkout stage, they should easily recognize and trust the payment options available. For example, highlight local payment methods prominently in regions where they are popular. -
Monitor Performance and Reliability:
Keep an eye on transaction success rates and processing times. PayOS’s dashboard provides insights into each payment method’s performance, enabling you to resolve any latency or downtime issues quickly to maintain customer trust. -
Scale with Your Business Growth:
As your business expands, your payment needs may evolve. PayOS’s flexible infrastructure makes it easy to add new payment methods, integrate with additional PSPs, or adjust your configurations to handle increased transaction volumes without compromising performance.
Additional Resources and Next Steps
With PayOS, managing and enabling diverse payment methods becomes more efficient and manageable. For detailed integration instructions, coding examples, and advanced customization options, explore these resources:
-
PayOS API Documentation
Dive deeper into PayOS’s API endpoints and discover how to implement server-to-server integrations, handle advanced payment flows, and manage transactions programmatically. -
Integration Guides
Review step-by-step guides for integrating PayOS’s SDKs or connecting to popular PSPs, ensuring a smooth setup experience regardless of your technical background or business model. -
M-Pesa Developer Documentation
Access comprehensive guides, API references, and best practices directly from M-Pesa to enhance your integration.
By configuring M-Pesa with PayOS, you can offer your customers a streamlined and secure mobile money payment experience tailored to their preferences and regional payment norms. Continuously refine your payment configurations and leverage PayOS’s robust features to stay agile in an ever-evolving e-commerce landscape.