PHP code example of codenson / daraja-api

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

codenson / daraja-api example snippets

namespace App\Http\Controllers;

use Codenson\Daraja\Facades\Daraja;
use Codenson\Daraja\Exceptions\DarajaException;

class MpesaController extends Controller
{
  

    //Get access token (auto-managed, but you can manually get it)
  public function getToken()
  {
      try {
          $token = Daraja::getAccessToken();
          return response()->json(['token' => $token]);
      } catch (DarajaException $e) {
          return response()->json(['error' => $e->getMessage()], 500);
      }
  }

  // Initiate STK Push
  public function stkPush(Request $request)
{
      try 
      {
          $response = Daraja::stkPush()->request([
              'amount' => 10,                              // Amount
              'phone_number' => '254712345678',            // Customer phone
              'account_reference' => 'INV-001',            // Order number
              'transaction_desc' => 'Payment for goods',   // Description
              'transaction_type' => 'CustomerPayBillOnline', // Optional
          ]);
          
          if ($response['ResponseCode'] === '0') 
          {
              return response()->json([
                  'success' => true,
                  'checkout_request_id' => $response['CheckoutRequestID']
              ]);
          }
      } catch (DarajaException $e) 
      {
          return response()->json(['error' => $e->getMessage()], 500);
      }
  }

  // Query STK Push status
  public function queryStatus($checkoutRequestID)
  {
      try 
      {
          $response = Daraja::stkPush()->query($checkoutRequestID);
          
          if ($response['ResultCode'] === '0') {
              return response()->json([
                  'success' => true,
                  'receipt_number' => $response['CallbackMetadata']['Item'][1]['Value']
              ]);
          }
      } catch (DarajaException $e) {
          return response()->json(['error' => $e->getMessage()], 500);
      }
  }

  // Register C2B URLs
public function registerC2B()
{
    try {
        $response = Daraja::c2b()->registerURLs(
            'https://your-domain.com/c2b/confirmation',
            'https://your-domain.com/c2b/validation'
        );
        
        return response()->json($response);
    } catch (DarajaException $e) {
        return response()->json(['error' => $e->getMessage()], 500);
    }
}

  // Simulate C2B (sandbox only)
  public function simulateC2B(Request $request)
  {
      try 
      {
          $response = Daraja::c2b()->simulate(
              '254712345678',  // Phone number
              100,             // Amount
              'CustomerPayBillOnline' // Command ID
          );
          
          return response()->json($response);
      } catch (DarajaException $e) {
          return response()->json(['error' => $e->getMessage()], 500);
      }
  }

    // Send B2C payment
    public function sendB2C(Request $request)
    {
        try 
        {
            $response = Daraja::b2c()->send([
                'amount' => 1000,                        // Amount
                'phone_number' => '254712345678',        // Recipient phone
                'command_id' => 'BusinessPayment',       // SalaryPayment, BusinessPayment, PromotionPayment
                'remarks' => 'Salary payment',           // Remarks
                'occasion' => 'January salary',          // Optional occasion
            ]);
            
            if ($response['ResponseCode'] === '0') {
                return response()->json([
                    'success' => true,
                    'conversation_id' => $response['ConversationID']
                ]);
            }
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Query account balance
    public function checkBalance()
    {
        try 
        {
            $response = Daraja::accountBalance()->query([
                'shortcode' => '174379',                 // Optional, uses config by default
                'identifier_type' => 4,                  // 1=MSISDN,2=Till,3=Shortcode,4=Organization
                'remarks' => 'Daily balance check',      // Remarks
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Reverse a transaction
    public function reverseTransaction(Request $request)
    {
        try 
        {
            $response = Daraja::reversal()->reverse([
                'transaction_id' => 'SDF45T56789',      // Transaction to reverse
                'amount' => 1000,                        // Amount to reverse
                'receiver_shortcode' => '174379',        // Optional
                'remarks' => 'Customer requested reversal',
                'occasion' => 'Wrong amount',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Remit tax to KRA
    public function remitTax(Request $request)
    {
        try 
        {
            $response = Daraja::taxRemittance()->remit([
                'amount' => 5000,                        // Tax amount
                'payer_number' => '254712345678',        // Payer phone
                'pin' => 'A001234567',                   // KRA PIN
                'period' => '2025-01',                   // Tax period (Y-m)
                'remarks' => 'Monthly tax remittance',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Pay bill from business account
    public function payBill(Request $request)
    {
        try 
        {
            $response = Daraja::businessPayBill()->pay([
                'amount' => 15000,                       // Amount
                'paybill_number' => '123456',            // Paybill to pay
                'account_reference' => 'INV-12345',      // Account reference
                'remarks' => 'Invoice payment',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Pay for goods from business account
    public function buyGoods(Request $request)
    {
        try 
        {
            $response = Daraja::businessBuyGoods()->pay([
                'amount' => 5000,                        // Amount
                'till_number' => '123456',               // Till number
                'account_reference' => 'ORDER-001',      // Order reference
                'remarks' => 'Goods payment',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Create a bill
    public function createBill(Request $request)
    {
        try 
        {
            $response = Daraja::billManager()->createBill([
                'customer_name' => 'John Doe',           // Customer name
                'customer_phone' => '254712345678',      // Customer phone
                'amount' => 2500,                        // Bill amount
                'due_date' => '2025-02-15',              // Due date (Y-m-d)
                'bill_reference' => 'BILL-001',          // Unique reference
                'description' => 'Water bill payment',   // Description
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Update bill status
    public function updateBill($billReference)
    {
        try 
        {
            $response = Daraja::billManager()->updateBill(
                $billReference,
                'PAID'  // PAID, PENDING, CANCELLED
            );
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Initiate B2B Express Checkout (USSD Push)
    public function b2bExpressCheckout(Request $request)
    {
        try 
        {
            $response = Daraja::b2bExpressCheckout()->push([
                'amount' => 10000,                       // Amount
                'payer_till' => '123456',                // Payer till number
                'payee_till' => '654321',                // Payee till number
                'account_reference' => 'TRANS-001',      // Reference
                'remarks' => 'B2B payment',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Pull transactions for reconciliation
    public function pullTransactions(Request $request)
    {
        try 
        {
            $response = Daraja::pullTransactions()->query([
                'start_date' => '2025-01-01',            // Start date (Y-m-d)
                'end_date' => '2025-01-31',              // End date (Y-m-d)
                'transaction_type' => 'C2B',             // C2B, B2C, etc.
                'page' => 1,                             // Page number
                'limit' => 100,                          // Results per page
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Send payment to Pochi La Biashara
    public function sendToPochi(Request $request)
    {
        try 
        {
            $response = Daraja::b2Pochi()->send([
                'amount' => 5000,                        // Amount
                'phone_number' => '254712345678',        // Recipient phone
                'pochi_number' => 'POCHI123456',         // Pochi account number
                'remarks' => 'Payment to Micro SME',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Query IMSI information
    public function verifyIMSI(Request $request)
    {
        try 
        {
            $response = Daraja::imsi()->query([
                'phone_number' => '254712345678',        // Phone to verify
                '->getMessage()], 500);
        }
    }

    // Check SIM swap specifically
    public function checkSimSwap($phoneNumber)
    {
        try 
        {
            $response = Daraja::imsi()->checkSimSwap($phoneNumber);
            
            if ($response['sim_swap_detected']) {
                // Take action - flag account, request additional verification
                return response()->json(['warning' => 'SIM card recently changed']);
            }
            
            return response()->json(['safe' => true]);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Pay with Bonga Points
    public function payWithBonga(Request $request)
    {
        try 
        {
            $response = Daraja::lipaNaBonga()->pay([
                'amount' => 500,                         // Cash amount
                'phone_number' => '254712345678',        // Customer phone
                'bonga_points' => 1000,                  // Bonga points to use
                'till_number' => '123456',               // Till number
                'account_reference' => 'ORDER-001',      // Reference
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Check Bonga Points balance
    public function checkBongaBalance($phoneNumber)
    {
        try 
        {
            $response = Daraja::lipaNaBonga()->checkBalance($phoneNumber);
            
            return response()->json([
                'bonga_points' => $response['balance']
            ]);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Load funds to B2C shortcode
    public function topUpB2CAccount(Request $request)
    {
        try 
        {
            $response = Daraja::b2cAccountTopUp()->topUp([
                'amount' => 50000,                       // Amount to load
                'reference' => 'TOPUP-001',              // Reference
                'remarks' => 'Monthly fund loading',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Create standing order
    public function createStandingOrder(Request $request)
    {
        try 
        {
            $response = Daraja::mpesaRatiba()->create([
                'amount' => 1000,                        // Amount per transaction
                'phone_number' => '254712345678',        // Customer phone
                'start_date' => '2025-02-01',            // Start date (Y-m-d)
                'end_date' => '2025-12-31',              // End date (Y-m-d)
                'frequency' => 'MONTHLY',                // DAILY, WEEKLY, MONTHLY
                'day_of_month' => 15,                    // For monthly (1-31)
                'day_of_week' => 'MON',                  // For weekly (MON, TUE, etc.)
                'account_reference' => 'LOAN-001',       // Reference
                'remarks' => 'Loan repayment',
            ]);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Cancel standing order
    public function cancelStandingOrder($orderId)
    {
        try 
        {
            $response = Daraja::mpesaRatiba()->cancel($orderId);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Query standing order status
    public function queryStandingOrder($orderId)
    {
        try 
        {
            $response = Daraja::mpesaRatiba()->query($orderId);
            
            return response()->json($response);
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }

    // Generate dynamic QR code
    public function generateQRCode(Request $request)
    {
        try 
        {
            $response = Daraja::dynamicQR()->generate([
                'merchant_name' => 'My Store',           // Merchant name
                'ref_no' => 'INV-001',                   // Reference number
                'amount' => 1500,                        // Amount
                'trx_code' => 'BG',                      // BG=Buy Goods, PB=Paybill
                'cpi' => '123456',                       // Till/Paybill number
                'size' => '300',                         // QR size in pixels
            ]);
            
            if ($response['ResponseCode'] === '0') {
                return response()->json([
                    'qr_code' => $response['QRCode'],    // Base64 encoded image
                    'response_description' => $response['ResponseDescription']
                ]);
            }
        } catch (DarajaException $e) {
            return response()->json(['error' => $e->getMessage()], 500);
        }
    }
}

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Codenson\Daraja\Models\DarajaTransaction;

class MpesaCallbackController extends Controller
{
  

    // STK Push Callback
    public function stkCallback(Request $request)
    {
        $data = $request->all();
        $stkCallback = $data['Body']['stkCallback'];
        
        // Store transaction
        DarajaTransaction::create([
            'transaction_type' => 'STK',
            'merchant_request_id' => $stkCallback['MerchantRequestID'],
            'checkout_request_id' => $stkCallback['CheckoutRequestID'],
            'result_code' => $stkCallback['ResultCode'],
            'result_desc' => $stkCallback['ResultDesc'],
            'amount' => $stkCallback['CallbackMetadata']['Item'][0]['Value'] ?? null,
            'mpesa_receipt_number' => $stkCallback['CallbackMetadata']['Item'][1]['Value'] ?? null,
            'phone_number' => $stkCallback['CallbackMetadata']['Item'][4]['Value'] ?? null,
            'raw_response' => json_encode($data)
        ]);
        
        if ($stkCallback['ResultCode'] === 0) {
            // Payment successful - update order, send notification, etc.
            $this->handleSuccessfulPayment($stkCallback);
        }
        
        // Always return success to M-PESA
        return response()->json(['ResultCode' => 0, 'ResultDesc' => 'Success']);
    }
    

    // C2B Confirmation
    public function c2bConfirmation(Request $request)
    {
        $data = $request->all();
        
        DarajaTransaction::create([
            'transaction_type' => 'C2B',
            'transaction_id' => $data['TransID'],
            'amount' => $data['TransAmount'],
            'phone_number' => $data['MSISDN'],
            'account_reference' => $data['BillRefNumber'],
            'mpesa_receipt_number' => $data['TransID'],
            'raw_response' => json_encode($data)
        ]);
        
        // Process the payment
        return response()->json(['ResultCode' => 0, 'ResultDesc' => 'Success']);
    }

    // C2B Validation
    public function c2bValidation(Request $request)
    {
        $data = $request->all();
        
        // Validate transaction (check account, limits, etc.)
        if ($this->isValidTransaction($data)) {
            return response()->json(['ResultCode' => 0, 'ResultDesc' => 'Success']);
        }
        
        return response()->json(['ResultCode' => 1, 'ResultDesc' => 'Validation failed']);
    }

   
    // B2C Result
    public function b2cResult(Request $request)
    {
        $data = $request->all();
        
        DarajaTransaction::create([
            'transaction_type' => 'B2C',
            'result_code' => $data['Result']['ResultCode'],
            'result_desc' => $data['Result']['ResultDesc'],
            'amount' => $data['Result']['ResultParameters']['ResultParameter'][0]['Value'] ?? null,
            'phone_number' => $data['Result']['ResultParameters']['ResultParameter'][1]['Value'] ?? null,
            'raw_response' => json_encode($data)
        ]);
        
        return response()->json(['ResultCode' => 0, 'ResultDesc' => 'Success']);
    }

    private function handleSuccessfulPayment($callback)
    {
        // Update order status
        // Send email/SMS notification
        // Generate receipt
        // Trigger other business logic
    }
}

Route::prefix('mpesa')->group(function () {
    Route::post('/stk-callback', [MpesaCallbackController::class, 'stkCallback']);
    Route::post('/c2b-confirmation', [MpesaCallbackController::class, 'c2bConfirmation']);
    Route::post('/c2b-validation', [MpesaCallbackController::class, 'c2bValidation']);
    Route::post('/b2c-result', [MpesaCallbackController::class, 'b2cResult']);
    Route::post('/b2c-timeout', [MpesaCallbackController::class, 'b2cTimeout']);
});

# Run all tests
composer test

# Run specific test
./vendor/bin/phpunit tests/Unit/STKPushServiceTest.php

# Run with coverage
composer test-coverage

# Test API configuration (returns current config values)
Route::get('/mpesa/test-config', function () {
    return [
        'environment' => config('daraja.environment'),
        'shortcode' => config('daraja.shortcode'),
        'has_consumer_key' => !empty(config('daraja.consumer_key')),
        'has_consumer_secret' => !empty(config('daraja.consumer_secret')),
        'has_passkey' => !empty(config('daraja.passkey')),
        'has_callback_urls' => !empty(config('daraja.callback_urls.stk_push')),
    ];
});