Prerequisites
| Requirement | Minimum version |
|---|---|
| Drupal | 9.0 |
| Commerce | 2.0 |
| PHP | 8.1 |
| Composer | 2.x |
| Simiz account | Create one free |
Installation
Configuration
Payment gateway settings
| Setting | Description |
|---|---|
| Display name | Payment method name shown to customers (default: “Mobile Money”) |
| Mode | Test (Sandbox) or Live (Production) |
| API Key | Your Simiz API key for the selected mode |
| Webhook Secret | Webhook signing secret from the Simiz dashboard |
Webhook URL
The module registers a webhook endpoint at:Payment flow
Payment is initiated
The module creates a transaction via the Simiz API. The customer is redirected to the Simiz checkout page.
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 |
| Airtel Money | Mobile Money | Coming Soon |
| M-Pesa | 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 |
| Ghanaian Cedi | GHS | Ghana |
| Nigerian Naira | NGN | Nigeria |
| Kenyan Shilling | KES | Kenya |
| Ugandan Shilling | UGX | Uganda |
| Rwandan Franc | RWF | Rwanda |
| Tanzanian Shilling | TZS | Tanzania |
Webhooks
| Event | Order action |
|---|---|
transaction.created | Order created with Draft status |
transaction.processing | Order status unchanged |
transaction.completed | Order marked as Completed |
transaction.failed | Order marked as Cancelled |
transaction.cancelled | Order marked as Cancelled |
transaction.expired | Order marked as Cancelled |
refund.created | Refund initiated |
refund.completed | Refund recorded on the order |
refund.failed | Log entry created |
Test mode
- Go to Commerce > Configuration > Payment gateways
- Edit your Simiz gateway and set the mode to Test
- Enter your sandbox API key (
smz_test_*) - Save
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
- Composer installation fails
Solutions:
- Verify your webhook URL in the Simiz dashboard
- Check that your webhook secret matches
- Ensure your server allows incoming POST requests
- Check Drupal logs at Reports > Recent log messages
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 history
| Version | Date | Changes |
|---|---|---|
1.0.0 | 2026-03-01 | Initial release — mobile money payments, webhooks, sandbox |

