Download the PHP package piteurstudio/satim-php without Composer
On this page you can find all versions of the php package piteurstudio/satim-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download piteurstudio/satim-php
More information about piteurstudio/satim-php
Files in piteurstudio/satim-php
Package satim-php
Short Description PHP package to interact with Satim.dz API
License MIT
Homepage https://github.com/piteurstudio/php-satim
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package satim-php
Satim.dz 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
PHP 8.1 or higher
Satim.dz API credentials (username, password, terminal ID) via CIBWeb.dz.
Installation
You can install the package via composer:
Usage
Configuration
Configure your Satim.dz API credentials using your project's preferred method of storing sensitive information.
Credentials example:
Initialization
Create a new Satim client by passing your API credentials:
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
Create a payment link with a few simple method calls:
Optional configuration methods:
| Method | Parameters | Description | Default Behavior |
|---|---|---|---|
description |
string $description |
Add a description to the payment | Not set |
failUrl |
string $url |
Set a custom fail redirect URL | Uses returnUrl() |
orderNumber |
int $orderNumber |
Use a custom 10-digit order number | Randomly generated |
testMode |
bool $isEnabled |
Enable Satim test APIs | Disabled |
language |
string $language |
Set payment page language | 'FR' (Accepts 'EN', 'AR', 'FR') |
timeout |
int $seconds |
Set payment timeout | 600 seconds (10 minutes) |
userDefinedFields |
array $fields |
Add multiple custom user-defined fields | Not set |
- Customize the payment process as needed for your specific use case
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.
Refund a Payment
To refund a payment, you can use the refundOrder method with the order ID returned from the payment link generation.
Payment Status
To retrieve the payment status, you can use the status method with the order ID returned from the payment link generation.
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contribution
We welcome all contributions! Please follow these guidelines:
- Document any changes in behavior — ensure
README.mdupdated accordingly. - Write tests to cover any new functionality.
- Please ensure that your pull request passes all tests.
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
Please review our security policy on how to report security vulnerabilities.
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.
Similar Packages
The following packages provide similar functionality by interacting with Satim through third-party services, rather than directly integrating with Satim:
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
- Nassim / PiteurStudio
- All Contributors
⭐ 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!
License
The MIT License (MIT). Please see License File for more information.
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.
