README

This Laravel plugin lets you work with the Payfort Payment API and manage multiple merchants easily.

Requirements

PHP 8.1+
Laravel 10+

Installation

You can install the package via composer:

composer require sevaske/payfort

You can publish the config file with:

php artisan vendor:publish --tag="payfort-config"

This is the contents of the published config file (payfort.php):

return [
    'sandbox_mode' => env('PAYFORT_SANDBOX_MODE', true),
    'log_channel' => env('PAYFORT_LOG_CHANNEL', 'stack'),
    'debug_mode' => env('PAYFORT_DEBUG_MODE', false),
    'language' => env('PAYFORT_LANGUAGE', 'en'), // en|ar
    'enable_requests_validation' => env('PAYFORT_ENABLE_REQUESTS_VALIDATION', true),
    'merchants' => [
        'default' => [
            'merchant_identifier' => env('PAYFORT_MERCHANT_IDENTIFIER'),
            'access_code' => env('PAYFORT_ACCESS_CODE'),
            'sha_request_phrase' => env('PAYFORT_SHA_REQUEST_PHRASE'),
            'sha_response_phrase' => env('PAYFORT_SHA_RESPONSE_PHRASE'),
            'sha_type' => env('PAYFORT_SHA_TYPE', 'sha256'),
        ],
        'apple' => [
            'merchant_identifier' => env('PAYFORT_APPLE_MERCHANT_IDENTIFIER'),
            'access_code' => env('PAYFORT_APPLE_ACCESS_CODE'),
            'sha_request_phrase' => env('PAYFORT_APPLE_SHA_REQUEST_PHRASE'),
            'sha_response_phrase' => env('PAYFORT_APPLE_SHA_RESPONSE_PHRASE'),
            'sha_type' => env('PAYFORT_APPLE_SHA_TYPE', 'sha256'),
        ],
        // multiple merchants can be added here
    ],
];

Add the following lines to your .env file and set values:

PAYFORT_SANDBOX_MODE=true
PAYFORT_DEBUG_MODE=false
PAYFORT_LOG_CHANNEL=stack
PAYFORT_LANGUAGE=en
# default merchant
PAYFORT_MERCHANT_IDENTIFIER=
PAYFORT_ACCESS_CODE=
PAYFORT_SHA_REQUEST_PASSPHRASE=
PAYFORT_SHA_RESPONSE_PASSPHRASE=
PAYFORT_SHA_TYPE=sha256
# merchant "apple"
PAYFORT_APPLE_MERCHANT_IDENTIFIER=
PAYFORT_APPLE_ACCESS_CODE=
PAYFORT_APPLE_SHA_REQUEST_PASSPHRASE=
PAYFORT_APPLE_SHA_RESPONSE_PASSPHRASE=
PAYFORT_APPLE_SHA_TYPE=sha256

Usage

use \Sevaske\Payfort\Exceptions\PayfortMerchantCredentialsException;
use \Sevaske\Payfort\Exceptions\PayfortRequestException;
use \Sevaske\Payfort\Exceptions\PayfortResponseException;
use \Sevaske\Payfort\Http\PayfortSignature;
use \Sevaske\Payfort\Http\PayfortResponse;
use \Sevaske\Payfort\Payfort;

try {
    $response = Payfort::merchant('default')
        ->api()
        ->checkStatus(merchantReference: 'ORDER-123456') // PayfortResponse
        ->getData(); // array
} catch (PayfortMerchantCredentialsException $exception) {
    // handle
} catch (PayfortRequestException $exception) {
    // handle
} catch (PayfortResponseException $exception) {
    // handle
}

// also
 Payfort::merchant('default')->api()->capture();
 Payfort::merchant('default')->api()->checkStatus();
 Payfort::merchant('default')->api()->createToken();
 Payfort::merchant('default')->api()->recurring();
 Payfort::merchant('default')->api()->refund();
 Payfort::merchant('default')->api()->updateToken();
 Payfort::merchant('default')->api()->voidAuthorization();

// custom request
Payfort::http()->request('POST', '/FortAPI/paymentApi', []);

// signature
$signature = (new PayfortSignature(shaPhrase: '', shaType: 'sha256'))
    ->calculateSignature([]);

Multiple merchants

Add new merchants in config/payfort.php.

Debug mode

Enables debug mode for logging detailed request/response information. You can set the "log_channel".

Beta Version

Note: This plugin is currently in beta. This means that while it is functional and ready for use, it may still have some bugs or incomplete features. We are actively working on improvements and welcome feedback to help us enhance the plugin.

What to Expect

Feature Set: Some features might be incomplete or subject to change based on user feedback and further development.
Stability: Although we strive for stability, you may encounter issues or bugs. Please report any problems you find.
Support: We provide basic support for beta users, but responses might be slower compared to stable releases.

Thank you for trying out our beta version and helping us make it better!

License

The MIT License (MIT). Please see License File for more information.

sevaske / payfort

Maintainers

Details