SDK Status
All official Simiz SDKs are maintained in sync with the Simiz API specification.
SDK Matrix
| SDK | Package | Version | Registry | Status |
|---|
| Node.js | @simiz/node-sdk | 1.0.0 | npm | 🟡 Pre-release |
| Python | simiz | 1.0.0 | PyPI | 🟡 Pre-release |
| PHP | simiz/simiz-php | 1.0.0 | Packagist | 🟡 Pre-release |
| Go | github.com/simiz-io/simiz-go | 1.0.0 | pkg.go.dev | 🟡 Pre-release |
| Ruby | simiz | 1.0.0 | RubyGems | 🟡 Pre-release |
| Android | io.simiz:simiz-android | 1.0.0 | Maven Central | 🟡 Pre-release |
| iOS (Swift) | SimizSDK | 1.0.0 | SPM | 🟡 Pre-release |
All SDKs follow Semantic Versioning. Breaking changes trigger a major version bump across all SDKs simultaneously.
API Coverage by SDK
The following endpoints are covered in each SDK. Coverage is tracked automatically against the OpenAPI specification.
Node.js
Python
PHP
Go
Ruby
| Resource | Endpoints | Status |
|---|
| Transactions | Create, Retrieve, List, Cancel, Verify | ✅ 1.0.0 |
| Refunds | Create, Retrieve, List | ✅ 1.0.0 |
| Customers | Create, Retrieve, Update, Delete, List | ✅ 1.0.0 |
| Webhooks (utils) | constructEvent, generateTestSignature | ✅ 1.0.0 |
| Payments | Create, List, Retrieve, Verify | 🔄 Roadmap |
| Payment Links | Create, List, Retrieve, Update, Delete | 🔄 Roadmap |
| Recurring | Create, Manage, Executions | 🔄 Roadmap |
| Webhook Endpoints | Create, List, Update, Delete, Test | 🔄 Roadmap |
| Payouts | Create, Approve, Cancel | 🔄 Roadmap |
npm install @simiz/node-sdk
| Resource | Endpoints | Status |
|---|
| Transactions | Create, Retrieve, List, Cancel, Verify | ✅ 1.0.0 |
| Refunds | Create, Retrieve, List | ✅ 1.0.0 |
| Customers | Create, Retrieve, Update, Delete, List | ✅ 1.0.0 |
| Webhooks (utils) | construct_event, generate_test_signature | ✅ 1.0.0 |
| Resource | Endpoints | Status |
|---|
| Transactions | Create, Retrieve, List, Cancel, Verify | ✅ 1.0.0 |
| Refunds | Create, Retrieve, List | ✅ 1.0.0 |
| Customers | Create, Retrieve, Update, Delete, List | ✅ 1.0.0 |
composer require simiz/simiz-php
| Resource | Endpoints | Status |
|---|
| Transactions | Create, Retrieve, List, Cancel, Verify | ✅ 1.0.0 |
| Refunds | Create, Retrieve, List | ✅ 1.0.0 |
| Customers | Create, Retrieve, Update, Delete, List | ✅ 1.0.0 |
go get github.com/simiz-io/simiz-go
| Resource | Endpoints | Status |
|---|
| Transactions | Create, Retrieve, List, Cancel, Verify | ✅ 1.0.0 |
| Refunds | Create, Retrieve, List | ✅ 1.0.0 |
| Customers | Create, Retrieve, Update, Delete, List | ✅ 1.0.0 |
Core Types
All SDKs expose consistent types across languages:
| Type | Description |
|---|
Currency | XAF | XOF | GHS | UGX | KES | NGN |
PaymentMethod | ORANGE_MONEY | MTN_MOMO | MOOV_MONEY | WAVE | CARD | BANK_TRANSFER |
TransactionStatus | PENDING | PROCESSING | COMPLETED | FAILED | CANCELLED | EXPIRED |
Transaction | Full transaction object |
Refund | Refund object |
Customer | Customer object |
WebhookEvent | Webhook event payload |
Breaking Changes Policy
When a breaking change is introduced in the API, all SDKs are bumped to a new major version simultaneously.
Breaking changes are announced:
- In the changelog of each affected SDK
- In the API Changelog documentation page
- Via email to developers who have opted-in to breaking change notifications