restoore/laravel-systempay

Easily create a systempay payment form.

1.0.2 2019-01-27 16:27 UTC

This package is not auto-updated.

Last update: 2021-07-24 01:47:09 UTC


README

Package Laravel Release Packagist MIT License

What is the point ?

The library provides an easy and fast systempay form creation. She helps to instanciate all required parameters and create the form to access to payment interface. To know required parameters, go to https://systempay.cyberpluspaiement.com/html/documentation.html

Installation

First you need to add the component to your composer.json

composer require restoore/laravel-systempay

Update your packages with composer update or install with composer install. Execute php artisan vendor:publish --provider="Restoore\Systempay\SystempayServiceProvider" command to copy systempay.php configuration file in your environment

After updating composer, add the ServiceProvider to the providers array in config/app.php

For Laravel >= 5.1

  'providers' => [
      ...
      Restoore\Systempay\SystempayServiceProvider::class,
  ]

For Laravel 5.0

  'providers' => [
      ...
      Restoore\Systempay\SystempayServiceProvider,
  ]

For Laravel >= 5.5

It's automatic, thanks to xmoroccan for this update

Configuration

By default, the package comes with an example configuration file : config/systempay.php

return [

    'YOUR_SITE_ID' => [
        'key' => 'YOUR_KEY',
        'env' => 'PRODUCTION',
        'params' => [
            //Put here your generals payment call parameters
            'vads_page_action' => 'PAYMENT',
            'vads_action_mode' => 'INTERACTIVE',
            'vads_payment_config' => 'SINGLE',
            'vads_page_action' => 'PAYMENT',
            'vads_version' => 'V2',
            'vads_currency' => '978'
        ]
    ],
    //Systempay's url
    'url' => 'https://paiement.systempay.fr/vads-payment/',

];

In this file, you have to put your site_id and your key. This two parameters are given by Systempay. As you can see, you can create a configuration array to several shops. In this array, you can also put generals parameters of your transaction.

Test environment

If you are running your app in a test environment, you can override key and env parameters using .env file

Use this following constants names : SYSTEMPAY_<SITE_ID>KEY and SYSTEMPAY<SITE_ID>_ENV

Create a payment form

Now we are finally ready to use the package! Here is a little example of code to explain how does it work

    //create a Systempay object class with your site id in parameter. Note that it will automatically get your configuration in config/systempay.php
   $systempay = App::make('systempay', ['site_id' => '11111']);
    //add some parameters
    $systempay->set_amount(1500)
        ->set_trans_id(1112441)
        ->set_order_info2('New customer !');
    //create the signature
    $systempay->set_signature();
    //create html systempay call form
    $payment_form = $systempay->get_form('<button class="btn btn-lg btn-primary btn-payment" type="submit">Valider et payer</button>');

What you have to know about this code

  1. You can get and set all Systempay parameters using accessor
  2. All setters are chainables functions
  3. Signature will be automatically calculated and put to the parameters array. Don't use this function before giving all parameters.
  4. get_form function takes the form button you want to show in parameter. Don't forget to use {!! !!} for surrounding the variable in your view.

Other useful functions

add_product

Add a product to the order

Parameters

array $product , must have the following keys : 'label,amount,type,ref,qty

Exemples

    $systempay = App::make('systempay', ['site_id' => '11111']);
    $systempay->add_product(
        [
            'label' => 'Concert Coldplay 2016',
            'amount' => 235.00,
            'type' => 'ENTERTAINMENT',
            'ref' => 'COLD016',
            'qty' => 3
        ]
    );

Note : the amount of each products price must not be multiplied by 100

set_amount

Defines the total amount of the order. If you doesn't give the amount in parameter, it will be automaticly calculated by the sum of products you've got in your basket.

Parameters

[optional] int $amount, systempay format. ex : for a product with a price of 150€, give 15000

Exemples

   $systempay = App::make('systempay', ['site_id' => '11111']);
   $systempay->add_product(
       [
           'label' => 'Concert Coldplay 2016',
           'amount' => 235.00,
           'type' => 'ENTERTAINMENT',
           'ref' => 'COLD016',
           'qty' => 3
       ]
   );
   $systempay->set_amount();
   echo $systempay->get_amount(); //will display 705.00 (3*235.00)

get_amount

Get total amount of the order

Parameters

[optional] bool $decimal if true, you get a decimal otherwise you get standard systempay amount format (int). Default value is true.

Exemples

  $systempay = App::make('systempay', ['site_id' => '11111']);
  $systempay->add_product(
      [
          'label' => 'Concert Coldplay 2016',
          'amount' => 235.00,
          'type' => 'ENTERTAINMENT',
          'ref' => 'COLD016',
          'qty' => 3
      ]
  );
  $systempay->set_amount();
  echo $systempay->get_amount(); //will display 705.00 (3*235.00)
  echo $systempay->get_amount(false); //will display 70500 (3*235.00)

set_params

Method to do massive assignement of parameters

Parameters

array $params associative array of systempay parameters

Exemples

   $systempay = App::make('systempay', ['site_id' => '11111']);
   $systempay->set_params(
       [
           'vads_page_action' => 'PAYMENT',
           'vads_action_mode' => 'INTERACTIVE',
           'vads_payment_config' => 'SINGLE',
           'vads_page_action' => 'PAYMENT',
           'vads_version' => 'V2',
           'vads_trans_date' => gmdate('YmdHis'),
           'vads_currency' => '978'
       ]
   );