codeonweekends/mpesa-php-sdk

(Unofficial) PHP SDK for the MPesa payment gateway by Vodacom Mozambique

v1.1.3 2021-07-11 11:59 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• ext-openssl: *
• guzzlehttp/guzzle: ~6.0
• illuminate/support: *
• phpseclib/phpseclib: ^2.0

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Amandio Nhamande

README

composer require codeonweekends/mpesa-php-sdk

Usage

The easiest way to use the API is by calling Codeonweekends\Mpesa\Mpesa and accessing the available transaction methods.

• Create an instance of Codeonweekends\Mpesa\Mpesa
• Get the api context using the getApiContext() method
• Set the public key and the api key on the context using setPublicKey(YOUR_PUBLIC_KEY) and setApiKey(YOUR_API_KEY) respectively

Example:

$mpesa = new Codeonweekends\Mpesa\Mpesa();
$context = $mpesa->getApiContext();

$context->setPublicKey(YOUR_PUBLIC_KEY);
$context->setApiKey(YOUR_API_KEY);

Create a C2B Transaction

$c2b = $mpesa->c2b($thirdPartyReference, $amount, $customerMSISDN, $serviceProviderCode, $transactionReference);

View a Transaction Status

$status = $mpesa->transactionStatus($queryReference, $serviceProviderCode, $securityCredential, $initiatorIdentifier);

Transaction Reversal

$reversal = $mpesa->transactionReversal($amount, $serviceProviderCode, $transactionID, $securityCredential, $initiatorIdentifier);

Running Test Suite

1. Open the file phpunit.xml and fill the <env/> values with appropriate information
2. Run vendor/bin/phpunit

e.g.

<env name="MPESA_PUBLIC_KEY" value="Your Public Key Here" />
<env name="MPESA_API_KEY" value="Your API Key Here" />
<env name="MPESA_SERVICE_PROVIDER_CODE" value="The Service Provider Code Here" />
<env name="MPESA_CUSTOMER_MSISDN" value="Customer MSISDN here" />
<env name="MPESA_SECURITY_CREDENTIAL" value="Security Credential" />
<env name="MPESA_INITIATOR_IDENTIFIER" value="Initiator Identifier" />

Further Improvements

• Documentation
• Laravel support