OzuPay Payment Gateway for M-Pesa
| 开发者 | fearofbug |
|---|---|
| 更新时间 | 2026年9月7日 02:40 |
| PHP版本: | 8.0 及以上 |
| WordPress版本: | 7.1 |
| 版权: | GPLv2 or later |
| 版权网址: | 版权信息 |
详情介绍:
- STK Push payments — send a payment prompt directly to the customer's phone via the Daraja API
- Payment waiting modal — shows payment status in real time on the confirmation page
- Retry support — customers can resend the STK Push prompt up to 2 times if they missed it
- Manual verification fallback — if automation fails, customers can submit their M-Pesa transaction code for admin review
- Paybill fallback matching — matches an external Paybill payment by account reference
- Transaction log — every Daraja API request and callback is logged for easy troubleshooting
- Sandbox testing panel — test your Daraja credentials in the sandbox before going live
- Health check — instant feedback on missing credentials, SSL issues, and other common misconfigurations
- Privacy tools integration — supports WooCommerce personal-data export and erasure
- HPOS compatible — works with WooCommerce High-Performance Order Storage
- Blocks compatible — works with the WooCommerce Cart/Checkout Block editor
- M-Pesa on Delivery (COD Deposit) — deposit + balance on delivery gateway
- C2B Buy Goods (Till) Reconciliation — match Till payments made outside an STK prompt
- B2C Automatic Refunds — process WooCommerce refunds via the Daraja B2C API
- Analytics Dashboard — revenue, conversion, and payment path charts
- Scheduled Email Reports — daily, weekly, or monthly payment summary emails
- POS REST API — REST endpoints for the OzuPay Android cashier application
- Webhook Enrichment — add M-Pesa receipt data to WooCommerce webhook payloads
- WooCommerce is required — OzuPay is a WooCommerce payment gateway and does not run without it
- A Safaricom Daraja developer account (free at developer.safaricom.co.ke)
- Store currency must be set to KES (Kenyan Shilling)
- A public HTTPS URL for Daraja callbacks (required for production; not needed for sandbox testing)
安装:
- Upload the
ozupay-payment-gatewayfolder to the/wp-content/plugins/directory, or install directly through the WordPress plugins screen. - Activate the plugin through the Plugins screen in WordPress.
- Go to OzuPay → Settings and enter your Daraja credentials.
- Go to WooCommerce → Payments and enable the M-Pesa gateway.
- Configure the gateway title and description under WooCommerce → Payments → M-Pesa → Manage.
- Test with the Sandbox Testing panel before going live.
- Create a free developer account at developer.safaricom.co.ke
- Create an app under My Apps and add the Lipa Na M-Pesa product
- Copy the Consumer Key and Consumer Secret from the Keys tab
- Copy the STK Passkey from the sandbox credentials section
- Use shortcode 174379 and passkey from the test credentials page for sandbox testing
屏幕截图:
常见问题:
What is the test phone number for sandbox STK Push?
Safaricom's official sandbox test phone is 254708374149. Any STK Push to this number in sandbox mode will succeed. You can change this in the Sandbox Testing panel.
What are the sandbox credentials?
Shortcode: 174379 Passkey: bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919 These are public Safaricom test credentials. The plugin's Sandbox Testing panel can pre-fill these automatically.
Why is the gateway not showing at checkout?
The most common reasons:
- The store currency is not set to KES — go to WooCommerce → Settings → General
- The gateway is not enabled — go to WooCommerce → Payments and enable M-Pesa
- Consumer Key, Consumer Secret, Shortcode, or Passkey is missing — go to OzuPay → Settings
- The Health Check panel (OzuPay → Settings → Health Check) will tell you exactly what is missing
Why is "Invalid TransactionType" returned by Daraja?
Your Shortcode Type setting does not match the type registered in Daraja. Paybill numbers use CustomerPayBillOnline and Till numbers use CustomerBuyGoodsOnline. The sandbox shortcode 174379 is a Paybill — set the type to Paybill.
Do callbacks work on localhost, and is HTTPS required?
Daraja requires a publicly accessible HTTPS callback URL. For local testing, use a secure tunnel such as ngrok, then confirm delivery with the Sandbox Testing panel.
Can I upgrade to Pro later without losing data?
Yes. The free and Pro editions use the same database tables and option names (ozupay_mpesa_settings, wp_ozupay_mpesa_transactions). Upgrading to Pro or switching back to free never deletes your data.
Where are API credentials stored?
Consumer Key, Consumer Secret, and STK Passkey are stored AES-256-GCM encrypted in the WordPress options table. The encryption key is derived from your site's AUTH_KEY and SECURE_AUTH_KEY constants. They are never stored in plain text.
Does this plugin phone home or send usage data?
Payment processing uses Daraja. Optional OzuPay diagnostics are off by default and run only after you opt in. The report includes your hostname and is not anonymous. Details follow.
更新日志:
- Change: Declared and verified WooCommerce 11.1 compatibility.
- Change: The classic (non-Blocks) checkout's M-Pesa gateway now defaults its title to "M-Pesa Pay Now" instead of plain "M-Pesa", matching the block-based checkout. Only affects new installs; a saved custom title is untouched. For the full version history, see changelog.txt in the plugin package.