PHPackages piteurstudio/satim-php - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. piteurstudio/satim-php ActiveLibrary[API Development](/categories/api) piteurstudio/satim-php ====================== PHP package to interact with Satim.dz API v1.0.2(1y ago)321.0k8[2 PRs](https://github.com/PiteurStudio/satim-php/pulls)MITPHPPHP ^8.1CI passing Since Jan 31Pushed 5mo ago4 watchersCompare [ Source](https://github.com/PiteurStudio/satim-php)[ Packagist](https://packagist.org/packages/piteurstudio/satim-php)[ Docs](https://github.com/piteurstudio/php-satim)[ RSS](/packages/piteurstudio-satim-php/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (3)Dependencies (7)Versions (6)Used By (0) [![Satim logo](images/satim.png)](images/satim.png) [![Satim PHP Client](https://camo.githubusercontent.com/877d247746502b3c542ad2e99082b5402fd947fcc8d0a579713a1e233db7169b/68747470733a2f2f62616e6e6572732e6265796f6e64636f2e64652f536174696d2e647a253230504850253230436c69656e742e706e673f7468656d653d6c69676874267061636b6167654d616e616765723d636f6d706f7365722b72657175697265267061636b6167654e616d653d70697465757273747564696f253246736174696d2d706870267061747465726e3d617263686974656374267374796c653d7374796c655f31266465736372697074696f6e3d412b66756c6c792b6f70656e2d736f757263652b5048502b7061636b6167652b666f722b7365616d6c6573732b696e746567726174696f6e2b776974682b536174696d2e647a266d643d312673686f7757617465726d61726b3d3126666f6e7453697a653d3735707826696d616765733d68747470732533412532462532467777772e7068702e6e6574253246696d616765732532466c6f676f732532466e65772d7068702d6c6f676f2e737667)](https://camo.githubusercontent.com/877d247746502b3c542ad2e99082b5402fd947fcc8d0a579713a1e233db7169b/68747470733a2f2f62616e6e6572732e6265796f6e64636f2e64652f536174696d2e647a253230504850253230436c69656e742e706e673f7468656d653d6c69676874267061636b6167654d616e616765723d636f6d706f7365722b72657175697265267061636b6167654e616d653d70697465757273747564696f253246736174696d2d706870267061747465726e3d617263686974656374267374796c653d7374796c655f31266465736372697074696f6e3d412b66756c6c792b6f70656e2d736f757263652b5048502b7061636b6167652b666f722b7365616d6c6573732b696e746567726174696f6e2b776974682b536174696d2e647a266d643d312673686f7757617465726d61726b3d3126666f6e7453697a653d3735707826696d616765733d68747470732533412532462532467777772e7068702e6e6574253246696d616765732532466c6f676f732532466e65772d7068702d6c6f676f2e737667) [![PHP Version Require](https://camo.githubusercontent.com/8c274db836b09b648357299ddd5687fd64844ad1d7084fe260c38f3237aa3482/68747470733a2f2f706f7365722e707567782e6f72672f70697465757273747564696f2f736174696d2d7068702f726571756972652f706870)](https://packagist.org/packages/piteurstudio/satim-php)[![Latest Version on Packagist](https://camo.githubusercontent.com/10709451228ea7b73b3af82a59812abbf2b3a396653b3159a8a08206e3b1b64d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f70697465757273747564696f2f736174696d2d7068702e7376673f7374796c653d666c6174)](https://packagist.org/packages/piteurstudio/satim-php)[![codecov](https://camo.githubusercontent.com/e2616615f2b578422d6f6c52cd9cec43d48a6f9e7b39166904a4b9dd51726ecd/68747470733a2f2f636f6465636f762e696f2f67682f50697465757253747564696f2f736174696d2d7068702f6272616e63682f6d61696e2f67726170682f62616467652e7376673f746f6b656e3d4d584b51435134414758)](https://codecov.io/gh/PiteurStudio/satim-php)[![PHPStan](https://camo.githubusercontent.com/0125b23a77da42eb3201e2c060e19edf75d1235b40fca5593791514536ac41ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d6d61782d626c75652e7376673f7374796c653d666c6174)](https://github.com/PiteurStudio/satim-php/blob/main/phpstan.neon)[![Tests](https://camo.githubusercontent.com/306b1a19d96101935090a5a2b06e142222adadd321b8c06df16b7e366c1f8158/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f70697465757273747564696f2f7068702d736174696d2f72756e2d74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c6174)](https://github.com/piteurstudio/php-satim/actions/workflows/run-tests.yml)[![Total Downloads](https://camo.githubusercontent.com/5bd63b090aa6cca290d8b741bdb4feecaf2996652e7efa76840751cf198869ca/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f70697465757273747564696f2f736174696d2d7068702e7376673f7374796c653d666c6174)](https://packagist.org/packages/piteurstudio/satim-php)[![License](https://camo.githubusercontent.com/895ae6b8ab66651a7d40082f629c4638f1cb1d59d1d93e2e9c9121fca07a3e16/68747470733a2f2f706f7365722e707567782e6f72672f70697465757273747564696f2f736174696d2d7068702f6c6963656e7365)](https://packagist.org/packages/piteurstudio/satim-php) Satim.dz PHP Client =================== [](#satimdz-php-client) A fully open-source PHP package for seamless integration with **Satim.dz**, the official interbank payment gateway in Algeria. This package enables merchants and developers to generate secure payment links and retrieve payment statuses directly via the Satim API, facilitating transactions through both **CIB** and **Edahabia** cards. > ### Requirements > > [](#requirements) > > PHP 8.1 or higher > > Satim.dz API credentials (username, password, terminal ID) via [CIBWeb.dz](https://www.cibweb.dz/). Installation ------------ [](#installation) You can install the package via composer: ``` composer require piteurstudio/satim-php ``` Usage ----- [](#usage) ### Configuration [](#configuration) Configure your Satim.dz API credentials using your project's preferred method of storing sensitive information. Credentials example: ``` SATIM_USERNAME=your-satim-username SATIM_PASSWORD=your-satim-password SATIM_TERMINAL_ID=your-satim-terminal-id ``` ### Initialization [](#initialization) Create a new Satim client by passing your API credentials: ``` use PiteurStudio\Satim; $satim = new Satim([ 'username' => env('SATIM_USERNAME'), 'password' => env('SATIM_PASSWORD'), 'terminal_id' => env('SATIM_TERMINAL_ID'), ]); ``` ### Main Methods [](#main-methods) The Satim provides the following methods: - Register a new payment order: `register()` - Confirm the status of a payment: `confirm($orderId)` - Refund a payment: `refund($orderId)` - Retrieve payment status: `status($orderId)` ### Generate a Payment Link [](#generate-a-payment-link) Create a payment link with a few simple method calls: ``` $payment = $satim ->amount(1000) /* Set payment amount in DZD dinars*/ ->description('Product purchase') /* Optional: Add a description*/ ->returnUrl('https://example.com/success') ->failUrl('https://example.com/fail') // Optional: Specify a different fail URL ->orderNumber(1234567890) // Optional: Use custom order number ->testMode(true) // Optional: Enable test mode ->language('AR') // Optional: Set payment page language (EN, AR, FR - default is FR) ->timeout(600) // Optional: Set payment timeout in seconds ->userDefinedFields([ 'customer_id' => '12345', 'order_type' => 'premium' ]) // Optional: Add custom user-defined fields ->register(); // Retrieve payment information $paymentDetails = $payment->getResponse(); $orderId = $payment->getOrderId(); $paymentUrl = $payment->getUrl(); // Redirect user to payment page $payment->redirect(); ``` #### Optional configuration methods: [](#optional-configuration-methods) MethodParametersDescriptionDefault Behavior`description``string $description`Add a description to the paymentNot set`failUrl``string $url`Set a custom fail redirect URLUses `returnUrl()``orderNumber``int $orderNumber`Use a custom 10-digit order numberRandomly generated`testMode``bool $isEnabled`Enable Satim test APIsDisabled`language``string $language`Set payment page language'FR' (Accepts 'EN', 'AR', 'FR')`timeout``int $seconds`Set payment timeout600 seconds (10 minutes)`userDefinedFields``array $fields`Add multiple custom user-defined fieldsNot set- Customize the payment process as needed for your specific use case ### Confirm Payment [](#confirm-payment) This method need to be used when the user is redirected back to your website after the payment process on return URL or fail URL. To confirm the status of a payment, you can use the `confirm` method with the order ID returned from the payment link generation. ``` $orderConfirmation = $satim->confirm($orderId); // Retrieve payment status $orderConfirmation->getResponse(); if ($orderConfirmation->isSuccessful()) { echo 'Payment was successful : '.$orderConfirmation->getSuccessMessage(); } else { // Payment was not successful echo 'Payment was not successful' : $orderConfirmation->getErrorMessage(); } ``` ### Refund a Payment [](#refund-a-payment) To refund a payment, you can use the `refundOrder` method with the order ID returned from the payment link generation. ``` $refundOrder = $satim->refund($orderId); $refundOrder->getResponse(); ``` ### Payment Status [](#payment-status) To retrieve the payment status, you can use the `status` method with the order ID returned from the payment link generation. ``` $orderStatus = $satim->status($orderId); $orderStatus->getResponse(); ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contribution ------------ [](#contribution) We welcome all contributions! Please follow these guidelines: 1. Document any changes in behavior — ensure `README.md` updated accordingly. 2. Write tests to cover any new functionality. 3. Please ensure that your pull request passes all tests. Issues & Suggesting Features -------------------------------- [](#issues--suggesting-features) If you encounter any issues or have ideas for new features, please open an issue. We appreciate your feedback and contributions to help improve this package. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. --- Extra Notes ----------- [](#extra-notes) Satim.dz system operates using the robust banking technologies provided by **BPC Group**. Note that many functions in BPC Payment System are restricted for public use by Satim.dz - the official [BPC Payment Documentation](https://dev.bpcbt.com/en/integration/api/rest/rest.html#api_overview). ### Similar Packages [](#similar-packages) The following packages provide similar functionality by interacting with Satim through third-party services, rather than directly integrating with Satim: - **[Chargily](https://github.com/orgs/Chargily/repositories?q=php)** - **[Slick Pay](https://github.com/orgs/Slick-Pay-Algeria/repositories)** - **[ALPAY](https://github.com/alpaydz?tab=repositories)** These packages may be useful depending on your use case. If you’ve developed a package that interacts with Satim via a third-party, feel free to submit a pull request to add it here. --- Credits ------- [](#credits) - [Nassim](https://github.com/n4ss1m) / [PiteurStudio](https://github.com/PiteurStudio) - [All Contributors](../../contributors) ⭐ Support --------- [](#-support) If you find this package helpful, please consider giving it a ⭐ on GitHub! Your support encourages us to keep improving the project. Thank you! [![Stargazers repo roster for @PiteurStudio/satim-php](https://camo.githubusercontent.com/71db8c7f0dc92aea28ad44fddbfd596989ab364df34ed6a9bbd4d009a5ac32e2/68747470733a2f2f7265706f726f737465722e636f6d2f73746172732f6461726b2f50697465757253747564696f2f736174696d2d706870)](https://github.com/PiteurStudio/satim-php/stargazers) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. Disclaimer ---------- [](#disclaimer) This package is not officially affiliated with or endorsed by **Satim.dz** or any other third-party. The name, logo, and trademarks are the property of their respective owners. ### Health Score 41 — FairBetter than 89% of packages Maintenance58 Moderate activity, may be stable Popularity31 Limited adoption so far Community15 Small or concentrated contributor base Maturity50 Maturing project, gaining track record Bus Factor1 Top contributor holds 98.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 3 Last Release 470d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/5a296ccb9da91508036477d715ab4295a2b8fc47a8c0f468733cac6691995d9a?d=identicon)[Nassim](/maintainers/Nassim) --- Top Contributors [![n4ss1m](https://avatars.githubusercontent.com/u/1750845?v=4)](https://github.com/n4ss1m "n4ss1m (128 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)") --- Tags algeriacibcibwebedahabiapayment-gatewaypayment-integrationphpsatimphpAlgeriaedahabiaPiteurStudiosatim-phpsatim.dzalgerie poste ### Code Quality TestsPest Static AnalysisPHPStan, Rector Code StyleLaravel Pint Type Coverage Yes ### Embed Badge ![Health badge](/badges/piteurstudio-satim-php/health.svg) ``` [![Health](https://phpackages.com/badges/piteurstudio-satim-php/health.svg)](https://phpackages.com/packages/piteurstudio-satim-php) ``` ### Alternatives [openai-php/symfony Symfony Bundle for OpenAI 215715.5k3](/packages/openai-php-symfony)[deepseek-php/deepseek-php-client deepseek PHP client is a robust and community-driven PHP client library for seamless integration with the Deepseek API, offering efficient access to advanced AI and data processing capabilities. 47073.9k5](/packages/deepseek-php-deepseek-php-client)[afiqiqmal/malaysiaholiday to get all holidays date in malaysia 329.0k](/packages/afiqiqmal-malaysiaholiday)[google-gemini-php/symfony Symfony Bundle for Gemini 149.4k1](/packages/google-gemini-php-symfony) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)