Prerequisites
| Requirement | Minimum version |
|---|---|
| WordPress | 6.0 |
| PHP | 8.1 |
| Simiz account | Create one free |
Installation
Download the plugin
Download the Simiz for WordPress plugin from your Simiz dashboard.You’ll receive a
.zip file named simiz-wordpress.zip.Upload and activate
- Go to your WordPress admin panel
- Navigate to Plugins > Add New > Upload Plugin
- Select the
simiz-wordpress.zipfile and click Install Now - Click Activate Plugin
Configuration
Navigate to Settings > Simiz Payments in your WordPress admin.| Setting | Description |
|---|---|
| Environment | Sandbox or Production |
| API Key | Your Simiz API key for the selected environment |
| Webhook Secret | Webhook signing secret from the Simiz dashboard |
| Success URL | Page to redirect to after successful payment |
| Cancel URL | Page to redirect to after cancelled payment |
Webhook URL
The plugin registers a webhook endpoint at:Shortcode usage
Embed a payment button or form anywhere on your site using the[simiz_payment] shortcode.
Basic usage
Full parameters
| Parameter | Description | Default |
|---|---|---|
amount | Payment amount in the smallest currency unit | Required |
currency | Currency code (XAF, XOF, etc.) | Store default |
description | Payment description | ”Payment” |
button_text | Text displayed on the pay button | ”Pay Now” |
success_url | Redirect URL after success | Plugin default |
cancel_url | Redirect URL after cancel | Plugin default |
class | CSS class for the button | simiz-pay-button |
Examples
REST API
For custom AJAX-based payments, the plugin exposes a REST endpoint:Request body
Response
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 | Action |
|---|---|
transaction.created | Payment recorded as Pending |
transaction.processing | Payment status updated to Processing |
transaction.completed | Payment marked as Completed, success callback triggered |
transaction.failed | Payment marked as Failed |
transaction.cancelled | Payment marked as Cancelled |
transaction.expired | Payment marked as Expired |
refund.created | Refund initiated |
refund.completed | Refund recorded |
refund.failed | Refund failure logged |
Test mode
- Go to Settings > Simiz Payments
- 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
- Shortcode not rendering
- REST API returns 401
- Webhooks not received
Solutions:
- Ensure the plugin is activated
- Check that the shortcode parameters are valid
- Verify there are no JavaScript errors on the page
- Clear your WordPress cache
Next steps
WooCommerce Integration
Need e-commerce? Use the WooCommerce plugin instead.
Webhook Verification
Learn about webhook configuration and signature verification.
API Reference
Explore the full Simiz API.
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 |

