Joomshopping Payments: M-Pesa

Accept payments via M-Pesa (Safaricom) — the customer enters their phone number, confirms the charge on their phone, and the shop waits for the result on its own.

The addon adds M-Pesa as a payment method in JoomShopping using the STK Push scenario. The customer does not leave for a third-party site: they enter their phone number right in the shop, receive a payment confirmation prompt on their phone, enter their PIN — and the shop page refreshes itself as soon as Safaricom confirms the payment. All requests and responses are stored in a dedicated shop table.

Features

• Payment without leaving for a third-party site: the customer enters their phone number on the shop page
• STK Push: the payment confirmation prompt arrives directly on the customer's phone
• The shop page tracks the payment state itself and moves on to the order confirmation as soon as the payment goes through
• Automatic conversion of the phone number to the international format — the customer may enter it the way they are used to
• Handling of the callback (IPN) from Safaricom with the result code, description and M-Pesa receipt number stored
• All transactions are stored in a dedicated shop table: order number, request identifiers, phone, amount, status, receipt number and the full Safaricom response
• Automatic order status change based on the payment result: separate statuses for successful, pending and failed payments — each selected from your shop's status list
• On a rejection the customer returns to the payment method selection with the error text from Safaricom
• Choice of the transaction type: payment to a Paybill or to Buy Goods (Till)
• Every step of the exchange with Safaricom is written to the shop log paymentdata.log
• Test mode works with the Safaricom sandbox — the payment can be checked before the shop goes live

Settings

• Testmode — switching between the Safaricom sandbox and the live environment
• Consumer key — the application key from the Safaricom developer portal
• Consumer secret — the application secret
• Business shortcode — the code of your organisation (Paybill or Till)
• Passkey — the key used to sign the STK Push requests
• Transaction type — the transaction type: CustomerPayBillOnline or CustomerBuyGoodsOnline
• Default country code — the default country calling code
• Transaction end status — order status on a successful payment
• Transaction pending status — order status while the payment is being processed
• Transaction failed status — order status on a failed payment

Technical notes

• An account in the Safaricom developer portal (Daraja) with an M-Pesa Express application is required: the consumer key, secret, shortcode and passkey are taken from there
• Your shop must be reachable by the Safaricom servers from the outside over HTTPS, not protected by a password or restricted by IP — otherwise the payment callback will not arrive
• Amounts are passed to M-Pesa as whole numbers (without cents)
• The PHP cURL extension must be enabled on the server