Magento 2 - Simiz Docs

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

Requirement	Minimum version
Magento	2.4
PHP	8.1
Composer	2.x
Simiz account	Create one free

You need your Simiz API keys before configuring the module. Find them in Dashboard > Settings > API Keys.

Installation

Install via Composer

Run the following command in your Magento root directory:

composer require simiz/magento-payment

Enable the module

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

Configure the module

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

Configuration

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

General settings

Setting	Description
Enabled	Enable or disable Simiz as a payment method
Title	Payment method name shown to customers (default: “Mobile Money”)
Description	Description shown during checkout
Sort Order	Display order among payment methods

API credentials

Setting	Description
Environment	Sandbox or Production
Test API Key	Your sandbox key (`smz_test_xxxxxxxxxxxx`)
Test Webhook Secret	Sandbox webhook signing secret
Live API Key	Your production key (`smz_live_xxxxxxxxxxxx`)
Live Webhook Secret	Production 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

Customer checks out

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

Payment is initiated

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

Customer confirms payment

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

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

Method	Type	Status
Orange Money	Mobile Money	Available
MTN Mobile Money	Mobile Money	Available
Wave	Mobile Money	Coming Soon
Moov Money	Mobile Money	Coming Soon

Supported currencies

Currency	Code	Countries
Central African CFA Franc	XAF	Cameroon, Central African Republic, Chad, Congo, Equatorial Guinea, Gabon
West African CFA Franc	XOF	Benin, Burkina Faso, Ivory Coast, Guinea-Bissau, Mali, Niger, Senegal, Togo

Webhooks

Event	Order action
`transaction.created`	Order created with Pending Payment status
`transaction.completed`	Order marked as Processing, invoice created
`transaction.failed`	Order marked as Cancelled
`transaction.cancelled`	Order marked as Cancelled
`transaction.expired`	Order marked as Cancelled
`refund.created`	Refund initiated
`refund.completed`	Credit memo created
`refund.failed`	Comment added to order

Test mode

Go to Stores > Configuration > Sales > Payment Methods > Simiz Payments
Set the environment to Sandbox
Enter your sandbox API key (smz_test_*)
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

Payment not completing
Module not appearing at checkout
Composer installation fails

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

Symptoms: Simiz is not shown as a payment option.Solutions:

Confirm the module is enabled: bin/magento module:status Simiz_Payment
Verify the payment method is enabled in configuration
Check that your store currency is supported
Run bin/magento setup:di:compile and flush the cache

Symptoms: composer require fails with dependency errors.Solutions:

Ensure Magento 2.4+ and PHP 8.1+ are installed
Run composer update to resolve dependency conflicts
Check that your Composer authentication is configured

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

Version	Date	Changes
`1.0.0`	2026-03-01	Initial release — mobile money payments, webhooks, sandbox

​Prerequisites

​Installation

​Configuration

​General settings

​API credentials

​Webhook URL

​Payment flow

​Supported payment methods

​Supported currencies

​Webhooks

​Test mode

Full sandbox documentation

​Troubleshooting

​Next steps

Webhook Verification

API Reference

Sandbox Testing

Support

​Changelog

Prerequisites

Installation

Configuration

General settings

API credentials

Webhook URL

Payment flow

Supported payment methods

Supported currencies

Webhooks

Test mode

Troubleshooting

Next steps

Changelog