Course Content
Building Your First Mpesa Integration
This topic focuses on guiding you through the process of building a functional Mpesa integration from scratch. You will learn how to set up a backend for handling API requests, generate secure access tokens for authentication, and implement an STK Push transaction to facilitate payments. By the end of this topic, you will have a working example of Mpesa integration.
0/3
Backend Setup with PHP/Node.js/Other Frameworks
Generating Access Tokens
06:32
Implementing an STK Push Transaction
12:18
C2B and B2C Integrations
In this topic, learners will explore the core concepts of integrating Mpesa's Customer-to-Business (C2B) and Business-to-Customer (B2C) payment functionalities. The lessons will cover configuring C2B payments to enable customers to pay businesses and using B2C for disbursing funds to customers. Additionally, the topic will explain how to implement real-time transaction status updates to ensure seamless payment tracking and reconciliation.
0/3
Configuring C2B (Customer to Business) Payments
Using B2C (Business to Customer) for Disbursements
Real-Time Transaction Status Updates
Testing and Debugging
This topic focuses on ensuring the reliability and correctness of Mpesa integrations by testing in the sandbox environment, debugging using logs and tools like Postman, and eventually transitioning to the production environment. By the end of this topic, learners will be equipped with practical knowledge of testing and debugging their integration effectively.
0/3
Testing Transactions in the Sandbox Environment
Using Logs and Postman for Debugging
Moving to Production
00:00
Security and Best Practices
This topic covers the critical aspects of securing your Mpesa integration by properly managing API keys and tokens, handling errors in a way that improves the user experience, and complying with Mpesa’s integration guidelines. Following these practices ensures that your integration is secure, reliable, and in line with best practices, minimizing the risk of fraud and ensuring smooth operations.
0/3
Securing Your API Keys and Tokens
Handling Errors Gracefully
Complying with Mpesa Integration Guidelines
Real-World Application
This topic explores how Mpesa can be seamlessly integrated into real-world applications, particularly e-commerce platforms. It covers integrating payment systems, customizing user experiences to enhance payment flows, and using analytics for business insights. By the end of this topic, learners will understand how to leverage Mpesa for creating smoother and more efficient payment processes, as well as tracking transactions for actionable insights.
0/3
Integrating Mpesa into an E-Commerce Platform
Customizing User Experiences with Mpesa Payments
Analytics and Reporting
Build a Payment Gateway with Mpesa
In this project, learners will apply the skills acquired throughout the course to build a functional payment gateway integrated with Mpesa. The project will walk through the entire process, from backend setup and API integration to handling transactions and user feedback. By the end of this topic, learners will have developed a working payment gateway and be ready to present their projects for review and feedback.
0/3
Step-by-Step Implementation of a Working Payment Gateway
Presenting Your Project for Feedback
Final Project Submission
Introduction to Mpesa Integration
Gain an understanding of Mpesa’s role in facilitating mobile payments. Learn about its features, real-world applications, and benefits in businesses. This module covers the prerequisites for starting your Mpesa integration journey.
0/2
Overview of Mpesa services and APIs
11:02
Requirements for Mpesa Integration
00:45
Setting Up The Environment
In this topic, you learned how to set up the environment for Mpesa integration. This includes registering on the Mpesa Daraja Portal, acquiring API credentials, and using tools like Postman and Ngrok for development and testing. You also set up a local server, configured callback URLs, and simulated transactions in the sandbox environment. Finally, you prepared for production by understanding the approval process and transitioning to live operations. These steps form the foundation for successfully integrating Mpesa APIs into your application.
0/4
Tools and platforms needed (Postman, Ngrok, etc.)
Registering for Mpesa Daraja API
Overview of sandbox and production environments
Tools, Registration, and Environments Quiz
Understanding Mpesa APIs
This topic provides an overview of the various Mpesa APIs available for integration. You will learn about the key API services that facilitate mobile money transactions, such as the STK Push, C2B, B2C, and Account Balance APIs. Understanding how each API works will help you design robust and efficient payment systems, and ensure seamless transactions between businesses and customers.
0/3
Mpesa API documentation walkthrough
Authentication: Consumer Key and Secret
Key API Endpoints: STK Push, C2B, B2C, Balance Inquiry
Mpesa Integration – Daraja API :Crash Course
Applying the skills acquired throughout the course, the video below will guide you to build a functional payment gateway integrated with Mpesa. The project will walk through the entire process, from backend setup and API integration to handling transactions and user feedback. By the end of this topic, you will have developed a working payment gateway and be ready to present your projects for review and feedback.
0/2
Using Node.Js
Using PHP
M-Pesa Integration MasterClass
About Lesson

Lesson Summary

In this lesson, we will walk through the official Mpesa API documentation. This will help you understand how to read and navigate the documentation, identify the available endpoints, understand request and response formats, and know where to find additional resources for troubleshooting and support. By the end of this lesson, you will be comfortable using the Mpesa API documentation for all your integration needs.

Lesson Details:

  1. Introduction to Mpesa API Documentation

    • The Mpesa API documentation is hosted on the Safaricom Developer Portal and provides detailed information on how to interact with the Mpesa Daraja API.
    • The documentation includes all available API endpoints, request methods (POST, GET), and response formats, as well as guidelines on usage limits, error codes, and best practices.
    • You can access the official documentation here for the latest updates and features.

  2. Navigating the API Documentation
    The Mpesa API documentation is divided into key sections that describe the available services and how to use them effectively:

    • Introduction Section: Gives an overview of the API, authentication methods, and general setup instructions.
    • API Endpoints: Each API service (like STK Push, C2B, B2C, etc.) is listed here with detailed information on how to send requests and interpret responses.
    • Authentication and Authorization: Explains how to authenticate API requests using OAuth 2.0 tokens (the process of obtaining and using access tokens).
    • Request Parameters: Describes the required parameters that must be included in your API calls, such as the amount, phone number, and short code for various transactions.
    • Response Codes: Lists the possible response codes and their meanings, helping you understand what each response indicates (success, failure, errors).

  3. Key Mpesa APIs Covered in the Documentation

    • STK Push API:
      Used to initiate a payment request to a customer’s phone via Mpesa’s STK (Sim Tool Kit) Push. This API is primarily used for Customer-to-Business (C2B) transactions.

      • Endpoint: https://api.safaricom.co.ke/mpesa/stkpush/v1/processrequest
      • Required Parameters: PhoneNumber, Amount, Shortcode, LipaNaMpesaOnline

    • C2B (Customer to Business) API:
      Allows businesses to receive payments directly from customers through Mpesa.

    • B2C (Business to Customer) API:
      Used by businesses to send money to customers, such as disbursements and refunds.

      • Endpoint: https://api.safaricom.co.ke/mpesa/b2c/v1/paymentrequest
      • Required Parameters: Amount, PhoneNumber, Shortcode, CommandID

    • Account Balance API:
      Allows businesses to query the account balance of a specific shortcode.

      • Endpoint: https://api.safaricom.co.ke/mpesa/accountbalance/v1/query
      • Required Parameters: Shortcode, Initiator, SecurityCredential

  4. Understanding Response Formats and Error Codes

    • Successful Responses:
      When an API call is successful, Mpesa returns a 200 OK status along with a body containing transaction details (e.g., ResultCode: 0, ResultDesc: "Success").

    • Error Responses:
      When there is an error in the request, Mpesa returns a corresponding error code (e.g., ResultCode: 1, ResultDesc: "Insufficient funds"). The documentation provides details on possible error codes and troubleshooting steps.

  5. Best Practices for Using Mpesa APIs

    • Rate Limiting: Mpesa imposes rate limits to prevent abuse. Ensure your app handles rate limits by checking the documentation for acceptable limits on API calls.
    • Error Handling: Always account for potential errors in transactions by implementing robust error handling to address issues like invalid input, network failures, or insufficient funds.
    • Security: Use secure communication channels (HTTPS) and follow best practices for storing and using OAuth tokens and sensitive credentials.

  6. Getting Help and Additional Resources

    • FAQs and Support: If you encounter issues, check the developer FAQs and the support section on the Safaricom Developer Portal.
    • Developer Community: Join the Safaricom Developer Forum to ask questions, share experiences, and connect with other developers.

 

Summary

In this lesson, you learned how to navigate the Mpesa API documentation, including how to understand the different API endpoints, required parameters, and response formats. You explored key Mpesa APIs such as STK Push, C2B, B2C, and Account Balance, and gained insights on best practices for handling requests, responses, and error codes. This knowledge will be vital as you integrate Mpesa payments into your applications.

Previous
Next