The Simiz Magento 2 module lets you accept mobile money payments directly in your online store. Customers pay via Orange Money, MTN MoMo, and other mobile wallets — with automatic order updates through webhooks.

​
Prerequisites

RequirementMinimum version
Magento2.4
PHP8.1
Composer2.x
Simiz accountCreate one free
You need your Simiz API keys before configuring the module. Find them in Dashboard > Settings > API Keys.

​
Installation

1

Install via Composer

Run the following command in your Magento root directory:
composer require simiz/magento-payment
2

Enable the module

bin/magento module:enable Simiz_Payment
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
3

Configure the module

  1. Go to Stores > Configuration > Sales > Payment Methods
  2. Expand the Simiz Payments section
  3. Enter your API key and webhook secret
  4. Select your environment (Sandbox or Production)
  5. Save the configuration
  6. Flush the cache: bin/magento cache:flush

​
Configuration

Navigate to Stores > Configuration > Sales > Payment Methods > Simiz Payments.

​
General settings

SettingDescription
EnabledEnable or disable Simiz as a payment method
TitlePayment method name shown to customers (default: “Mobile Money”)
DescriptionDescription shown during checkout
Sort OrderDisplay order among payment methods

​
API credentials

SettingDescription
EnvironmentSandbox or Production
Test API KeyYour sandbox key (smz_test_xxxxxxxxxxxx)
Test Webhook SecretSandbox webhook signing secret
Live API KeyYour production key (smz_live_xxxxxxxxxxxx)
Live Webhook SecretProduction webhook signing secret

​
Webhook URL

The module registers a webhook endpoint at: 
https://your-store.com/simiz/webhook/notify
Copy this URL into your Simiz dashboard under Settings > Webhooks.

​
Payment flow

1

Customer checks out

The customer selects Mobile Money at checkout and chooses their provider.
2

Payment is initiated

The module creates a transaction via the Simiz API. The customer is redirected to the Simiz checkout page.
3

Customer confirms payment

The customer confirms the payment by entering their mobile money PIN.
4

Webhook confirms the order

Simiz sends a transaction.completed webhook. The module verifies the signature, creates an invoice, and updates the order status to Processing.

​
Supported payment methods

MethodTypeStatus
Orange MoneyMobile MoneyAvailable
MTN Mobile MoneyMobile MoneyAvailable
WaveMobile MoneyComing Soon
Moov MoneyMobile MoneyComing Soon
Airtel MoneyMobile MoneyComing Soon
M-PesaMobile MoneyComing Soon

​
Supported currencies

CurrencyCodeCountries
Central African CFA FrancXAFCameroon, Central African Republic, Chad, Congo, Equatorial Guinea, Gabon
West African CFA FrancXOFBenin, Burkina Faso, Ivory Coast, Guinea-Bissau, Mali, Niger, Senegal, Togo
Ghanaian CediGHSGhana
Nigerian NairaNGNNigeria
Kenyan ShillingKESKenya
Ugandan ShillingUGXUganda
Rwandan FrancRWFRwanda
Tanzanian ShillingTZSTanzania

​
Webhooks

EventOrder action
transaction.createdOrder created with Pending Payment status
transaction.processingOrder kept in Pending Payment
transaction.completedOrder marked as Processing, invoice created
transaction.failedOrder marked as Cancelled
transaction.cancelledOrder marked as Cancelled
transaction.expiredOrder marked as Cancelled
refund.createdRefund initiated
refund.completedCredit memo created
refund.failedComment added to order

​
Test mode

  1. Go to Stores > Configuration > Sales > Payment Methods > Simiz Payments
  2. Set the environment to Sandbox
  3. Enter your sandbox API key (smz_test_*)
  4. Save and flush the cache
The module connects to sandbox.api.simiz.io and no real money is charged.

Full sandbox documentation

See all test numbers and scenarios in the Sandbox Testing guide.

​
Troubleshooting

Symptoms: Order stays in “Pending Payment” after the customer pays.Solutions:
  • Verify your webhook URL is correctly configured in the Simiz dashboard
  • Check that your webhook secret matches
  • Ensure your server allows incoming POST requests
  • Check Magento logs in var/log/simiz.log

​
Next steps

Webhook Verification

Learn about webhook configuration and signature verification.

API Reference

Explore the full Simiz API.

Sandbox Testing

Test all payment scenarios before going live.

Support

Need help? Contact our support team.

​
Changelog

Version history

VersionDateChanges
1.0.02026-03-01Initial release — mobile money payments, webhooks, sandbox