SofizPay SDKs
Official client libraries to integrate SofizPay payments, CIB & EDAHABIA checkout, and digital services.
Official SDKs
5 supported environmentsJavaScript / TypeScript
v1.3.0For Node.js, Next.js, React, and browser environments.
Node.jsReactNext.jsBrowser
npm i sofizpay-js-sdk
View Documentation
Python
v1.1.0Async library with type hints for FastAPI, Django, and Flask.
FastAPIDjangoFlaskAsyncIO
pip install sofizpay-python-sdk
View Documentation
PHP
v1.1.0Composer package for Laravel and modern PHP backends.
LaravelWooCommercePHP 8+
composer require sofizpay/sofizpay-php-sdk
View Documentation
Dart / Flutter
v1.2.0Flutter package supporting Android, iOS, and web checkout.
FlutteriOSAndroidWeb
flutter pub add sofizpay_dart_sdk
View Documentation
Java / Kotlin
v1.1.0For Spring Boot microservices and Android applications.
Spring BootAndroidMavenJitPack
com.github.SofizPay:sofizpay-java-sdk:v1.1.0
View Documentation
CIB & EDAHABIA Sandbox
Simulate bank card payments and verify transaction status with test cards and OTP.
Signed Webhook Events
Receive real-time payment notifications and verify automated RSA SHA-256 signatures.
Unified Method Reference
All SDKs implement consistent method names across languages (camelCase for JS, PHP, Dart, and Java; snake_case for Python).
| Purpose | JS / Dart / Java / PHP (camelCase) | Python (snake_case) | Alias |
|---|---|---|---|
| Get SDK Version | getVersion() | get_version() | — |
| Derive Public Key from Secret | getPublicKey(secretKey) | get_public_key(secret_key) | getPublicKeyFromSecret() |
| Get DZT Balance | getBalance(publicKey) | get_balance(public_key) | getDzdBalance() (PHP) |
| Submit DZT Payment | submit(paymentData) | submit(payment_data) | sendPayment() / send_payment() |
| Get Exhaustive Transactions History | getTransactions(publicKey, limit) | get_transactions(public_key, limit) | getPaymentHistory() / get_all_transactions() |
| Search Transactions by Memo | searchTransactionsByMemo(key, memo, limit) | search_transactions_by_memo(...) | getTransactionsByMemo() |
| Fetch Transaction by Hash | getTransactionByHash(hash) | get_transaction_by_hash(hash) | — |
| Start Real-Time Transaction Stream | startTransactionStream(key, callback, ...) | start_transaction_stream(...) | setupTransactionStream() |
| Stop Transaction Stream | stopTransactionStream(keyOrId) | stop_transaction_stream(key_or_id) | — |
| Get Stream Status | getStreamStatus(keyOrId) | get_stream_status(key_or_id) | — |
| Create CIB/EDAHABIA Transaction | makeCIBTransaction(data) | make_cib_transaction(data) | Supports is_sandbox flag |
| Create Sandbox CIB Transaction | makeSandboxCIBTransaction(data) | make_sandbox_cib_transaction(data) | Dedicated simulation gateway |
| Check CIB Order Status | checkCIBStatus(cibTxId, isSandbox?) | check_cib_status(cib_tx_id, is_sandbox?) | Uses cib_transaction_id |
| Check Sandbox CIB Order Status | checkSandboxCIBStatus(cibTxId) | check_sandbox_cib_status(cib_tx_id) | Dedicated sandbox check |
| Verify Webhook Payload Signature | verifyWebhookSignature(payload) | verify_webhook_signature(payload) | Verifies cib.payment.updated |
| Raw RSA Digital Signature Verification | verifySignature(message, signature) | verify_signature(message, signature) | verify_sofizpay_signature() |
| Get Products & Offers List | getProducts(encryptedKey?) | get_products(encrypted_sk?) | — |
| Recharge Mobile Phone (Flexy) | rechargePhone(data) | recharge_phone(data) | Requires encrypted_sk |
| Recharge Internet Subscription | rechargeInternet(data) | recharge_internet(data) | Requires encrypted_sk |
| Recharge Gaming Credits | rechargeGame(data) | recharge_game(data) | Requires encrypted_sk |
| Pay Utility Bills | payBill(data) | pay_bill(data) | Requires encrypted_sk |
| Get Operations History | getOperationHistory(key, limit, offset) | get_operation_history(key, limit, offset) | — |
| Get Operation Details by ID | getOperationDetails(id, key) | get_operation_details(id, key) | — |