Code Snippets Library

PHP

Daraja API - STK Push (Lipa Na M-Pesa Online)

Complete PHP implementation of Safaricom Daraja API STK Push for Lipa Na M-Pesa Online. Includes access token generation and payment processing.

<?php
/**
 * Daraja API - STK Push (Lipa Na M-Pesa Online)
 * Complete implementation with error handling
 */

class MpesaSTKPush {
    private $consumerKey;
    private $consumerSecret;
    ...

daraja mpesa safaricom payment stkpush api

Daraja API - STK Push (Lipa Na M-Pesa Online)

Language: PHP

Description: Complete PHP implementation of Safaricom Daraja API STK Push for Lipa Na M-Pesa Online. Includes access token generation and payment processing.

Code:

<?php
/**
 * Daraja API - STK Push (Lipa Na M-Pesa Online)
 * Complete implementation with error handling
 */

class MpesaSTKPush {
    private $consumerKey;
    private $consumerSecret;
    private $businessShortCode;
    private $passkey;
    private $environment; // "sandbox" or "production"
    
    public function __construct($environment = "sandbox") {
        $this->consumerKey = "YOUR_CONSUMER_KEY";
        $this->consumerSecret = "YOUR_CONSUMER_SECRET";
        $this->businessShortCode = "174379"; // Test shortcode
        $this->passkey = "YOUR_PASSKEY";
        $this->environment = $environment;
    }
    
    private function getBaseUrl() {
        if ($this->environment === "production") {
            return "https://api.safaricom.co.ke";
        }
        return "https://sandbox.safaricom.co.ke";
    }
    
    private function getAccessToken() {
        $url = $this->getBaseUrl() . "/oauth/v1/generate?grant_type=client_credentials";
        
        $credentials = base64_encode($this->consumerKey . ":" . $this->consumerSecret);
        
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            "Authorization: Basic " . $credentials
        ]);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        
        $response = curl_exec($ch);
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);
        
        if ($httpCode === 200) {
            $data = json_decode($response, true);
            return $data["access_token"] ?? null;
        }
        
        return null;
    }
    
    public function stkPush($phoneNumber, $amount, $accountReference, $transactionDesc) {
        $token = $this->getAccessToken();
        if (!$token) {
            return ["error" => "Failed to get access token"];
        }
        
        $url = $this->getBaseUrl() . "/mpesa/stkpush/v1/processrequest";
        
        $timestamp = date("YmdHis");
        $password = base64_encode($this->businessShortCode . $this->passkey . $timestamp);
        
        $postData = [
            "BusinessShortCode" => $this->businessShortCode,
            "Password" => $password,
            "Timestamp" => $timestamp,
            "TransactionType" => "CustomerPayBillOnline",
            "Amount" => (int)$amount,
            "PartyA" => $this->formatPhone($phoneNumber),
            "PartyB" => $this->businessShortCode,
            "PhoneNumber" => $this->formatPhone($phoneNumber),
            "CallBackURL" => "https://yourdomain.com/mpesa-callback.php",
            "AccountReference" => $accountReference,
            "TransactionDesc" => $transactionDesc
        ];
        
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($postData));
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            "Authorization: Bearer " . $token,
            "Content-Type: application/json"
        ]);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        
        $response = curl_exec($ch);
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);
        
        if ($httpCode === 200) {
            return json_decode($response, true);
        }
        
        return ["error" => "STK Push failed", "response" => $response];
    }
    
    private function formatPhone($phone) {
        // Convert to format 254XXXXXXXXX
        $phone = preg_replace("/[^0-9]/", "", $phone);
        
        if (substr($phone, 0, 1) === "0") {
            $phone = "254" . substr($phone, 1);
        }
        
        return $phone;
    }
}

// Usage example
$mpesa = new MpesaSTKPush("sandbox");
$result = $mpesa->stkPush(
    "0712345678", 
    100, 
    "INV001", 
    "Payment for services"
);

if (isset($result["ResponseCode"]) && $result["ResponseCode"] === "0") {
    echo "STK Push sent successfully. Check your phone to complete payment.";
    echo "CheckoutRequestID: " . $result["CheckoutRequestID"];
} else {
    echo "Error: " . ($result["error"] ?? "Unknown error");
}
?>

Tags: daraja,mpesa,safaricom,payment,stkpush,api

PHP

Daraja API - C2B (Customer to Business)

Implement Customer to Business payments with validation and confirmation URLs

<?php
/**
 * Daraja API - C2B (Customer to Business)
 * Register URLs and process payments
 */

class MpesaC2B {
    private $consumerKey;
    private $consumerSecret;
    private $shortCode;...

daraja mpesa c2b payment api

Daraja API - C2B (Customer to Business)

Language: PHP

Description: Implement Customer to Business payments with validation and confirmation URLs

Code:

<?php
/**
 * Daraja API - C2B (Customer to Business)
 * Register URLs and process payments
 */

class MpesaC2B {
    private $consumerKey;
    private $consumerSecret;
    private $shortCode;
    private $environment;
    
    public function __construct($environment = "sandbox") {
        $this->consumerKey = "YOUR_CONSUMER_KEY";
        $this->consumerSecret = "YOUR_CONSUMER_SECRET";
        $this->shortCode = "600000"; // Test shortcode
        $this->environment = $environment;
    }
    
    private function getBaseUrl() {
        return $this->environment === "production" 
            ? "https://api.safaricom.co.ke" 
            : "https://sandbox.safaricom.co.ke";
    }
    
    private function getAccessToken() {
        $url = $this->getBaseUrl() . "/oauth/v1/generate?grant_type=client_credentials";
        $credentials = base64_encode($this->consumerKey . ":" . $this->consumerSecret);
        
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Basic " . $credentials]);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        
        $response = curl_exec($ch);
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);
        
        if ($httpCode === 200) {
            $data = json_decode($response, true);
            return $data["access_token"] ?? null;
        }
        return null;
    }
    
    public function registerUrls($validationUrl, $confirmationUrl) {
        $token = $this->getAccessToken();
        if (!$token) return ["error" => "Failed to get access token"];
        
        $url = $this->getBaseUrl() . "/mpesa/c2b/v1/registerurl";
        
        $postData = [
            "ShortCode" => $this->shortCode,
            "ResponseType" => "Completed",
            "ConfirmationURL" => $confirmationUrl,
            "ValidationURL" => $validationUrl
        ];
        
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($postData));
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            "Authorization: Bearer " . $token,
            "Content-Type: application/json"
        ]);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        
        $response = curl_exec($ch);
        curl_close($ch);
        
        return json_decode($response, true);
    }
    
    public function simulatePayment($phoneNumber, $amount, $reference) {
        $token = $this->getAccessToken();
        if (!$token) return ["error" => "Failed to get access token"];
        
        $url = $this->getBaseUrl() . "/mpesa/c2b/v1/simulate";
        
        $postData = [
            "ShortCode" => $this->shortCode,
            "CommandID" => "CustomerPayBillOnline",
            "Amount" => (int)$amount,
            "Msisdn" => $this->formatPhone($phoneNumber),
            "BillRefNumber" => $reference
        ];
        
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($postData));
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            "Authorization: Bearer " . $token,
            "Content-Type: application/json"
        ]);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        
        $response = curl_exec($ch);
        curl_close($ch);
        
        return json_decode($response, true);
    }
    
    private function formatPhone($phone) {
        $phone = preg_replace("/[^0-9]/", "", $phone);
        if (substr($phone, 0, 1) === "0") {
            $phone = "254" . substr($phone, 1);
        }
        return $phone;
    }
}

// Register URLs
$mpesa = new MpesaC2B("sandbox");
$result = $mpesa->registerUrls(
    "https://yourdomain.com/mpesa/validation.php",
    "https://yourdomain.com/mpesa/confirmation.php"
);

// Simulate payment
$simulate = $mpesa->simulatePayment("0712345678", 100, "TEST001");
?>

Tags: daraja,mpesa,c2b,payment,api

PHP

Daraja API - B2C (Business to Customer)

Send money from business to customer (B2C) - withdrawals, refunds, salary payments

<?php
/**
 * Daraja API - B2C (Business to Customer)
 * Send money to customers (withdrawals, refunds, salary)
 */

class MpesaB2C {
    private $consumerKey;
    private $consumerSecret;
   ...

daraja mpesa b2c withdrawal payment

Daraja API - B2C (Business to Customer)

Language: PHP

Description: Send money from business to customer (B2C) - withdrawals, refunds, salary payments

Code:

<?php
/**
 * Daraja API - B2C (Business to Customer)
 * Send money to customers (withdrawals, refunds, salary)
 */

class MpesaB2C {
    private $consumerKey;
    private $consumerSecret;
    private $initiatorName;
    private $securityCredential;
    private $shortCode;
    private $environment;
    
    public function __construct($environment = "sandbox") {
        $this->consumerKey = "YOUR_CONSUMER_KEY";
        $this->consumerSecret = "YOUR_CONSUMER_SECRET";
        $this->initiatorName = "testapi";
        $this->securityCredential = "YOUR_ENCRYPTED_PASSWORD";
        $this->shortCode = "600000";
        $this->environment = $environment;
    }
    
    private function getBaseUrl() {
        return $this->environment === "production" 
            ? "https://api.safaricom.co.ke" 
            : "https://sandbox.safaricom.co.ke";
    }
    
    private function getAccessToken() {
        $url = $this->getBaseUrl() . "/oauth/v1/generate?grant_type=client_credentials";
        $credentials = base64_encode($this->consumerKey . ":" . $this->consumerSecret);
        
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Basic " . $credentials]);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        
        $response = curl_exec($ch);
        curl_close($ch);
        
        $data = json_decode($response, true);
        return $data["access_token"] ?? null;
    }
    
    public function sendMoney($phoneNumber, $amount, $commandId, $remarks) {
        $token = $this->getAccessToken();
        if (!$token) return ["error" => "Failed to get access token"];
        
        $url = $this->getBaseUrl() . "/mpesa/b2c/v1/paymentrequest";
        
        $postData = [
            "InitiatorName" => $this->initiatorName,
            "SecurityCredential" => $this->securityCredential,
            "CommandID" => $commandId, // SalaryPayment, BusinessPayment, PromotionPayment
            "Amount" => (int)$amount,
            "PartyA" => $this->shortCode,
            "PartyB" => $this->formatPhone($phoneNumber),
            "Remarks" => $remarks,
            "QueueTimeOutURL" => "https://yourdomain.com/mpesa/b2c-timeout.php",
            "ResultURL" => "https://yourdomain.com/mpesa/b2c-result.php",
            "Occasion" => ""
        ];
        
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($postData));
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            "Authorization: Bearer " . $token,
            "Content-Type: application/json"
        ]);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        
        $response = curl_exec($ch);
        curl_close($ch);
        
        return json_decode($response, true);
    }
    
    private function formatPhone($phone) {
        $phone = preg_replace("/[^0-9]/", "", $phone);
        if (substr($phone, 0, 1) === "0") {
            $phone = "254" . substr($phone, 1);
        }
        return $phone;
    }
}

// Send salary payment
$mpesa = new MpesaB2C("sandbox");
$result = $mpesa->sendMoney(
    "0712345678",
    5000,
    "SalaryPayment",
    "January salary"
);

if (isset($result["ResponseCode"]) && $result["ResponseCode"] === "0") {
    echo "Payment initiated. ConversationID: " . $result["ConversationID"];
}
?>

Tags: daraja,mpesa,b2c,withdrawal,payment

PHP

Daraja API - Callback Handler

Handle STK Push callbacks and process payment notifications

<?php
/**
 * Daraja API - Callback Handler
 * Process STK Push callbacks
 */

// mpesa-callback.php
header("Content-Type: application/json");

// Get the callback data
$callbackData = file_g...

daraja mpesa callback webhook stkpush

Daraja API - Callback Handler

Language: PHP

Description: Handle STK Push callbacks and process payment notifications

Code:

<?php
/**
 * Daraja API - Callback Handler
 * Process STK Push callbacks
 */

// mpesa-callback.php
header("Content-Type: application/json");

// Get the callback data
$callbackData = file_get_contents("php://input");
$data = json_decode($callbackData, true);

// Log the callback for debugging
file_put_contents("mpesa_log.txt", date("Y-m-d H:i:s") . " - Callback received: " . $callbackData . PHP_EOL, FILE_APPEND);

// Check if this is an STK Push callback
if (isset($data["Body"]["stkCallback"])) {
    $callback = $data["Body"]["stkCallback"];
    
    $merchantRequestID = $callback["MerchantRequestID"] ?? "";
    $checkoutRequestID = $callback["CheckoutRequestID"] ?? "";
    $resultCode = $callback["ResultCode"] ?? "";
    $resultDesc = $callback["ResultDesc"] ?? "";
    
    // Process based on result code
    if ($resultCode == 0) {
        // Successful payment
        $metadata = $callback["CallbackMetadata"]["Item"] ?? [];
        
        $amount = 0;
        $mpesaReceiptNumber = "";
        $transactionDate = "";
        $phoneNumber = "";
        
        foreach ($metadata as $item) {
            switch ($item["Name"]) {
                case "Amount":
                    $amount = $item["Value"];
                    break;
                case "MpesaReceiptNumber":
                    $mpesaReceiptNumber = $item["Value"];
                    break;
                case "TransactionDate":
                    $transactionDate = $item["Value"];
                    break;
                case "PhoneNumber":
                    $phoneNumber = $item["Value"];
                    break;
            }
        }
        
        // TODO: Update your database with successful transaction
        
        $response = [
            "ResultCode" => 0,
            "ResultDesc" => "Success"
        ];
    } else {
        // Failed payment
        $response = [
            "ResultCode" => $resultCode,
            "ResultDesc" => $resultDesc
        ];
    }
    
    echo json_encode($response);
} else {
    // Handle other callback types
    echo json_encode(["ResultCode" => 0, "ResultDesc" => "Success"]);
}
?>

Tags: daraja,mpesa,callback,webhook,stkpush

Code Snippets

Popular Tags

Daraja API - STK Push (Lipa Na M-Pesa Online)

Daraja API - STK Push (Lipa Na M-Pesa Online)

Daraja API - C2B (Customer to Business)

Daraja API - C2B (Customer to Business)

Daraja API - B2C (Business to Customer)

Daraja API - B2C (Business to Customer)

Daraja API - Callback Handler

Daraja API - Callback Handler

Tech Assistant

Hello there!

Code Snippets

Popular Tags

Daraja API - STK Push (Lipa Na M-Pesa Online)

Daraja API - STK Push (Lipa Na M-Pesa Online)

Daraja API - C2B (Customer to Business)

Daraja API - C2B (Customer to Business)

Daraja API - B2C (Business to Customer)

Daraja API - B2C (Business to Customer)

Daraja API - Callback Handler

Daraja API - Callback Handler

Full Snippet

Tech Assistant

Hello there!