1. Go to this page and download the library: Download atendwa/mpesa-artisan library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
atendwa / mpesa-artisan example snippets
// instantiate the class
$stk = new STK();
$response = $stk->amount(34)->post();
// use the global helper
stk()->amount(34)->post();
// use the Daraja Facade
\Atendwa\MpesaArtisan\Facades\Daraja::stk()->amount(56)->post();
// use the daraja global helper
daraja()->stk()->buyGoods()->amount(78)->post();
$response = dynamic_qr()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->amount(100) // Required: sets the 'Amount' attribute
->buyGoods() // Optional: defaults the TrxCode attribute to 'BG'
// ->paybill() sets TrxCode to 'PB'
// ->sendMoney() sets TrxCode to 'SM'
// ->sendToBusiness() sets TrxCode to 'SB'
// ->withdrawFromAgent() sets TrxCode to 'WA'
->size(400) // Optional: default is 300
->merchantName('atendwa') // Required: sets the 'MerchantName' attribute
->reference('buy me a coffee') // Required: sets the 'RefNo' attribute
->creditPartyIdentifier('123456') // Required: sets the 'CreditPartyIdentifier (CPI)' attribute
->post();
$response = stk()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->partyB('1234567') // Optional: Specify a shortcode, defaults to the business shortcode
->buyGoods() // Optional: Choose between 'buyGoods' or 'payBill', defaults to 'buyGoods'
// ->payBill() // Optional: Choose between 'buyGoods' or 'payBill', defaults to 'buyGoods'
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->phoneNumber('254712345678') // Required: Specify the customer's phone number
->amount(1) // Required: Specify the amount to be transacted
->reference('test') // Required: Specify an account reference
->description('test') // Required: Specify a transaction description
->post();
$response = stk_query()
->driver('default') // Optional: defaults to 'default'
->useConsumerKeyPair(true) // Optional: defaults to true
->shortCode('1234567') // Optional: the package will attempt to use the business shortcode if not set
->checkoutRequestID($someID) // Required: The CheckoutRequestID from the STK push response
->post();
$response = register_c2b_urls()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->shortCode('123456') // Required: Specify the short code
->completed() // Optional: the ResponseType is 'Completed' by default
// ->cancelled() // Optional: sets the ResponseType attribute to 'Cancelled'
->confirmationUrl('https://tendwa.dev/package-sale/confirm') // Required: Specify the confirmation URL
->validationUrl('https://tendwa.dev/package-sale/validate') // Required: Specify the validation URL
->post();
$response = b2c()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(false) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->timeoutUrl('https://tendwa.dev') // Required: Specify the timeout URL
->partyA('123456')
->partyB('254712345678')
->initiator('123456') // Optional: defaults to the initiator name in the config file
->amount(100) // Required: Specify the amount. Must be > 50 for safaricom to process the request
->remarks('test') // Required: Specify the transaction remarks
->occasion('test') // Required: Specify the transaction occasion
->post()
$response = transaction_status()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(false) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->initiator('initiator') // Optional: defaults to the initiator name in the config file
->partyA('1234567')
->transactionID('NEF61H8J60') // Optional: use this if you have a transaction ID
// ->originatorConversationID('AG_20190826_0000777ab7d848b9e721') // Optional: use this if you don't have a transaction ID
->timeoutUrl('https://tendwa.dev') // Required: Specify the timeout URL
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->remarks('Transaction status request.') // Optional: defaults to 'Transaction status request.'
->occasion('Transaction status request.') // Optional: defaults to 'Transaction status request.'
->post();
$response = account_balance()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->partyA('123456')
->remarks('Get account balance.') // Optional: defaults to 'Get account balance.'
->timeoutUrl('https://tendwa.dev') // Required: Specify the timeout URL
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->post();
$response = reversal()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->occasion('Transaction reversal request.') // Required: Specify the occasion transaction or defaults to 'Transaction reversal request.'.
->remarks('Transaction reversal request.') // Required: Specify the occasion transaction or defaults to 'Transaction reversal request.'.
->timeoutUrl('https://tendwa.dev') // Required: Specify the timeout URL
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->initiator('initiator') // Optional: defaults to the initiator name in the config file
->receiverParty('1234567')
->amount(100) // Required: Specify the amount
->transactionID('NEF61H8J60') // Optional: use this if you have a transaction ID
->post();
$response = tax_remittance()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->initiator('initiator') // Optional: defaults to the initiator name in the config file
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->timeoutUrl('https://tendwa.dev') // Required: Specify the timeout URL
->partyA('1234567') // Required: Specify the shortcode
->partyB('572572') // Required: Specify the shortcode
->amount(100) // Required: Specify the amount
->remarks('Tax Remittance') // Optional: defaults to 'Tax Remittance'
->reference('Tax Remittance') // Optional: defaults to 'Tax Remittance'
->post();
$response = business_pay_bill()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->initiator('initiator') // Optional: defaults to the initiator name in the config file
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->timeoutUrl('https://tendwa.dev') // Required: Specify the timeout URL
->partyA('1234567') // Required: Specify the shortcode
->partyB('572572') // Required: Specify the shortcode
->amount(100) // Required: Specify the amount
->remarks('Business Payment') // Optional: defaults to 'Business Payment'
->reference('Business Payment') // Optional: defaults to 'Business Payment'
->post();
$response = business_buy_goods()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->initiator('initiator') // Optional: defaults to the initiator name in the config file
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->timeoutUrl('https://tendwa.dev') // Required: Specify the timeout URL
->partyA('1234567') // Required: Specify the shortcode
->partyB('572572') // Required: Specify the shortcode
->amount(100) // Required: Specify the amount
->remarks('Business Payment') // Optional: defaults to 'Business Payment'
->reference('Business Payment') // Optional: defaults to 'Business Payment'
->post();
$response = b2b_express_checkout()
->driver('default') // Optional: Specify a custom driver
->useConsumerKeyPair(true) // Optional: Toggle key pairs, defaults to true for consumer key and secret
->primaryShortCode('1234567') // Required: Specify the primary short code
->receiverShortCode('572572') // Required: Specify the receiver short code
->amount(100) // Required: Specify the amount
->reference('Business Payment') // Required: Specify the reference
->callbackUrl('https://tendwa.dev') // Required: Specify the callback URL
->requestRefID($someUniqueID) // Required
->partnerName($yourStoreName) // Required
->post();
use Atendwa\MpesaArtisan\Http\Requests\MpesaCallbackRequest;
public function handleStkCallback(MpesaCallbackRequest $request)
{
$response = $request->fetchResponse(); // returns the response body as a collection
$response->get('resultCode'); // returns the result code from the response body
// for stk push
$response->get('merchantRequestID');
// for b2c
$response->get('TransactionID'); // returns the result code from the response body
$request->log(); // logs the response to your logging system with the info level
$success = $request->successful(); // returns a boolean indicating if the transaction was successful by checking the result code
}
$response = parse_response(stk()->post());
$response->get('successfulResponse'); // returns true if the response was successful
$response->get('responseCode');
php
stk()->driver('web-store')->amount(5); //... chain more methods
stk()->driver('donation')->amount(80); //... chain more methods