README

Overview

This package provides a simple component to create a payment form for Banque Populaire's Systempay api.

Installation

In order to install the Laravel Boilerplate Systempay component, run:

composer require frenchykiller/laravel-systempay

Usage

To include the Systempay form in a page, simply add the component in your blade file:

<x-systempay :request="['amount' => 25]" />

Attributes

The following attributes are accepted:

Name	Type	Default	Description
request	array	null	Request containing the information to be sent to the systempay api to obtain the formToken. This request must contain the required `amount` field. Full documentation on aaccepted fields can be found here
hasButton	boolean	true	Whether or not to generate the payment button and associated events. If this is set to false, you will have to send the transaction request manually with all appropriate parameters
successPost	string	null	Post URL to redirect to if the payment is successful
successGet	string	null	Get URL to redirect to if the payment is successful
failPost	string	null	Post URL to redirect to if the payment is rejected
failGet	string	null	Get URL to redirect to if the payment is rejected
site	string	default	The name of the configuration to be used. Can be any name that is specified in the config file

Configuration

The component comes with a default config file making the component functional out of the box, however, if you wish to personalize the configuration, you can publish the config file with one of the following commands:

php vendor:publish --tag=systempay-config

By default, the configuration file located at config/systempay.php contains the following information:

return [
    'default' => [
        'site_id' => env('SYSTEMPAY_SITE_ID', '73239078'),
        'password' => env('SYSTEMPAY_PASSWORD', 'testpassword_SbEbeOueaMDyg8Rtei1bSaiB5lms9V0ZDjzldGXGAnIwH'),
        'key' => env('SYSTEMPAY_KEY', 'testpublickey_Zr3fXIKKx0mLY9YNBQEan42ano2QsdrLuyb2W54QWmUJQ'),
        'env' => env('SYSTEMPAY_ENV', 'TEST'),
        'url' => 'https://api.systempay.fr/api-payment/V4/',
        'params' => [
            'currency' => 'EUR',
            'formAction' => 'PAYMENT',
            'strongAuthentication' => 'NO_PREFERENCE', //Setting this to DISABLED will let the card issuer decide whether 3DS2 is required or not. This will also remove any payment guarantee for the merchant.
            'transactionOptions' => [
                'cardOptions' => [
                    'paymentSource' => 'EC', //Setting this to CC (Call Center) will disable all 3DS checks. This will also shift liability for chargebacks to the merchant.
                ],
            ],
        ],
    ],
];

To change the default configuration, simply set the SYSTEMPAY_SITE_ID, SYSTEMPAY_PASSWORD and SYSTEMPAY_KEY variables in the config file or your .env file. These values are given by Systempay.

If you wish to add extra sites to the same app, simply add new entries to the config file as follows:

return [
    'default' => [
        ...
    ],

    'site_name' => [
        'site_id' => 'your_site_id',
        'password' => 'your_site_password',
        'key' => 'your_site_key',
        'url' => 'https://api.systempay.fr/api-payment/V4/',
        'params' => [
            'currency' => 'USD', //required
            'formAction' => 'PAYMENT',
            'strongAuthentication' => 'ENABLED'
            //add other static params here
        ],
    ]

Testing

By default the package is set up to run in a test environment. To switch to prod you must set the SYSTEMPAY_SITE_ID, SYSTEMPAY_PASSWORD and SYSTEMPAY_KEY variables in your .env file or publish and change the config file as seen in the configuration section

Tests / Coding standards

This package is delivered with a Makefile used to launch checks for the respect of coding standards and the unit tests

Just call make to see the list of commands.

Contributing

Please see contributing.md for details and a todolist.

Credits

License

This package is free software distributed under the terms of the MIT license.

frenchykiller / laravel-systempay

Maintainers

Details