M Pesa (Safaricom Daraja API)

🚀 Daraja Project

The Daraja Project aims to provide a set of tools and frameworks based on Safaricom's Daraja API to simplify the integration of M-Pesa payment solutions. The project currently includes the following features:

• stk_push: Initiate an M-Pesa STK push request, prompting the customer to authorize payment on their mobile device.
• generate_qr_code: Generate a QR code for the customer to scan and complete the payment.
• account_balance: Query the account balance.
• b2c_payment: Implement the B2C payment function.

🚀 Quick Start

The Daraja Project offers a comprehensive set of tools and frameworks for seamless integration with M-Pesa payment solutions. With features like STK push, QR code generation, and account balance queries, it simplifies the payment process.

✨ Features

• stk_push: Initiate M-Pesa STK push requests for payment authorization.
• generate_qr_code: Generate QR codes for customer payments.
• account_balance: Check account balance.
• b2c_payment: Enable B2C payments.

📦 Installation

Please refer to the Installation Guide for project installation and configuration.

💻 Usage Examples

Payment Tools

stk_push

Initiate an M-Pesa STK push request, prompting the customer to authorize payment on their mobile device.

Input Parameters:

• amount (int): The amount to be paid.
• phone_number (int): The customer's phone number.

Return Value: M-PESA API response in JSON format.

generate_qr_code

Generate a QR code for the customer to scan and complete the payment.

Input Parameters:

• merchant_name (str): The name of the merchant.
• transaction_reference_no (str): The transaction reference number.
• amount (int): The total amount.
• transaction_type (Literal["BG", "WA", "PB", "SM", "SB"]): The type of transaction.
• credit_party_identifier (str): The identifier of the payee (phone number, business number, agent counter, Paybill, merchant item).

Return Value: M-PESA API response in JSON format, including QR code data.

Payment Prompts

stk_push_prompt

Generate a prompt for initiating an M-Pesa STK push payment request.

Input Parameters:

• phone_number (str): The customer's phone number.
• amount (int): The payment amount.
• purpose (str): The purpose of the payment.

Return Value: A formatted STK push request prompt string.

generate_qr_code_prompt

Generate a prompt for creating an M-Pesa QR code payment request.

Input Parameters:

• merchant_name (str): The name of the merchant.
• amount (int): The payment amount.
• transaction_type (str): The type of transaction (BG for buying goods, WA for wallet, PB for Paybill, SM for sending funds, SB for sending to business).
• identifier (str): The identifier of the payee (phone number, business number, agent counter, Paybill, merchant item).
• reference (str, optional): The transaction reference number. If not provided, a default one will be generated.

Return Value: A formatted QR code generation prompt string.

Document Processing Tools

create_source

Create a data connector from a data source to an unstructured server for data processing.

Input Parameters:

• connector_name (str): The name of the data source connector.

Return Value: The newly created connector object.

create_target

Create a data connector from an unstructured server to a target system for data processing.

Input Parameters:

• connector_name (str): The name of the target connector.
• target_system (str): The identifier of the target system.

Return Value: The newly created connector object.

transform

Define and apply a data transformation rule to the target connector.

Input Parameters:

• connector (TargetConnector): The target connector to be transformed.
• rule (Dict[str, Any]): The data transformation rule.

Return Value: The data result after applying the transformation.

Document Processing Prompts

extract

Extract specified information from a document.

Input Parameters:

• document (str): The content of the input document.
• fields (List[str]): The list of fields to be extracted.

Return Value: A dictionary of the extracted results.

classify

Classify a document.

Input Parameters:

• document (str): The content of the input document.
• categories (List[str]): The possible classification labels.

Return Value: The classification result and the confidence score.

📚 Documentation

• API Documentation: API Documentation Link
• Sample Code: Sample Code Repository

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for the specific license content.

Acknowledgments

We would like to thank the following organizations and individuals for their contributions and support to this project:

• Safaricom: Provided powerful M-Pesa service support.
• Open Source Community: Provided valuable feedback and technical support for the project's development and maintenance.