Prerequisites
| Requirement | Details |
|---|---|
| Shopify store | Any Shopify plan |
| Node.js | >= 18 (for custom app development) |
| Simiz account | Create one free |
Installation
Install from Shopify App Store
- Visit the Simiz Payments app on the Shopify App Store
- Click Add app
- Review the required permissions and click Install app
Connect your Simiz account
- After installation, you will be redirected to the Simiz configuration page
- Enter your Simiz API key (
smz_test_*for sandbox,smz_live_*for production) - Enter your webhook secret
- Click Save
Configuration
App settings
Access settings from Apps > Simiz Payments in your Shopify admin.| Setting | Description |
|---|---|
| Environment | Toggle between Sandbox and Production |
| API Key | Your Simiz API key for the selected environment |
| Webhook Secret | Webhook signing secret from the Simiz dashboard |
| Payment method title | Name shown to customers at checkout (default: “Mobile Money”) |
| Checkout mode | Redirect or Embedded checkout |
Checkout extension
The app integrates with Shopify’s checkout extensibility framework. It adds a payment option that appears alongside other payment methods during checkout. No additional theme modifications are required. The payment method renders automatically in both classic and checkout extensibility themes.Payment flow
Customer checks out
The customer selects Mobile Money as the payment method during Shopify checkout.
Payment is initiated
The app creates a transaction via the Simiz API. The customer is redirected to the Simiz checkout page to enter their phone number and select their provider.
Customer confirms payment
The customer receives a prompt on their phone and confirms the payment with their mobile money PIN.
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
The app handles webhook events automatically:| Event | Order action |
|---|---|
transaction.created | Order created with Payment pending status |
transaction.processing | Order kept in Payment pending |
transaction.completed | Order marked as Paid |
transaction.failed | Order marked as Failed |
transaction.cancelled | Order marked as Cancelled |
transaction.expired | Order marked as Failed |
refund.created | Refund initiated |
refund.completed | Refund recorded on the order |
refund.failed | Note added to the order |
Test mode
- Open the Simiz app in your Shopify admin
- Set the environment to Sandbox
- Enter your sandbox API key (
smz_test_*) - Save changes
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
- App not appearing at checkout
- Invalid API key errors
Symptoms: Order stays in “Payment pending” after the customer pays.Solutions:
- Verify the app is properly connected to your Simiz account
- Check that your webhook secret is correct
- Review webhook delivery logs in the Simiz dashboard
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 |

