README

mpesa stk push made easy , b2c , b2b

Daraja API PHP SDK

A lightweight Object-Oriented PHP SDK for integrating with the Safaricom Daraja API for effecient mpesa payments

This package simplifies working with Daraja services such as STK Push, STK Push Query, OAuth token generation, and other supported endpoints.

Features

• Object-Oriented API
• Composer compatible
• OAuth Access Token generation
• STK Push
• B2c payments
• B2B Payments
• B2Pochi payments
• Configurable using PHP configuration files
• Simple and easy to integrate

Requirements

• PHP 8.1 or later
• Composer
• Safaricom Daraja API credentials

Installation

Install the package using Composer:

composer require brotechsploit/daraja-api

Project Structure

daraja/
│
├── configs/
│   └── (Configuration files)
│
│
├── callback/
│   └── (Callback responses)
│
├── .env
│
├── example/
│
│── composer.json
│── composer.lock
│── src/
│   └── Daraja.php
│── vendor/
│   ├── autoload.php
│   ├── composer/
│   │   ├── autoload_psr4.php
│   │   ├── autoload_real.php
│   │   └── ...
│   └── vlucas/

Configuration

edit the .env file with the valid safaricom daraja credentials

Example: MPESA_CONSUMER_KEY=qP50LHCHnaIJajKsOMZAxbC3v0PoGvaj4GhQa02pszLy0e00 MPESA_CONSUMER_SECRET=i7dP8GRQJ4G6avPzM4GfUBKvAJ4pdaRUT0SajUPuEfnUhjAhSScGR4YHcIwnwPKW MPESA_PASSKEY=bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919 MPESA_SHORTCODE=174379 MPESA_CALLBACK_URL=https://example.com/callback/ MPESA_INITIATOR_USERNAME=apiuser MPESA_SECURITY_CREDENTIALS=i7dP8GRQJ4G6avPzM4GfUBKvAJ4pdaRUT0SajUPuEfnUhjAhSScGR4YHcIwnwPKW QueueTimeOutURL=https://example.com/timeout.php ResultURL=https://example.com/result.php

return [
    'consumerkey' => MPESA_CONSUMER_KEY,
    'consumersecret' => MPESA_CONSUMER_SECRET,
    'shortcode' => MPESA_SHORTCODE,
    'passkey' => MPESA_PASSKEY,
    'callbackurl' => MPESA_CALLBACK_URL,
    'sandbox' => true, // change to false for production
    'apiusername' => MPESA_API_USERNAME,
    'apipassword' => MPESA_API_PASSWORD,
    'timeouturl' => QueueTimeOutURL,
    'resulturl' => ResultURL

];

Basic Usage

<?php

require 'vendor/autoload.php';

use Brotechsploit\Daraja\Daraja;

$config = require 'configs/classconnect.php';

$daraja = new Daraja($config);

$response = $daraja->stkPush(
    '254712345678',
    1,
    'Payment'
);

print_r($response);

Callback Handling

Configure your callback URL inside your Safaricom Developer Portal. we have a sample of the callback code in the callback/callback.php The callback data can then be processed and stored according to your application's requirements.

Environment

The package supports:

• Sandbox
• Production

Simply update your configuration to switch environments.

Example

An example implementation is provided in:

/example/mpesastkpush.php

Security

Do not commit your production credentials.

Store sensitive information in your .env file and exclude it from version control using .gitignore.

Contributing

Contributions, bug reports, and feature requests are welcome.

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Open a Pull Request.

Author

Vincent Oloo

If you find this package useful, consider giving the repository a ⭐ on GitHub.