README.rst

PHP library for the PayPlug API

This is the documentation of PayPlug's PHP library. It is designed to help developers to use PayPlug as payment solution in a simple, yet robust way.

You can create a PayPlug account at http://payplug.com.

Prerequisites

PayPlug's library relies on cURL to perform HTTP requests and requires OpenSSL (1.0.1 or newer) to secure transactions. You also need PHP 5.3 or newer for the PayPlug PHP V2.

For version PHP 5.2 or older you must refer to PayPlug PHP V1.

Documentation

Please see https://www.payplug.com/docs/api for latest documentation.

Installation

Option 1 - Strongly preferred) via composer:

• Get composer from composer website.
• Make sure you have initialized your composer.json.
• Run composer require payplug/payplug-php from your project directory.

Option 2) clone the repository :

git clone https://github.com/payplug/payplug-php.git

Option 3) download as a tarball :

• Download the most recent tarball from the download page V2 (V2 for PHP 5.3 or newer)
• Download the most recent tarball from the download page V1 (V1 for PHP 5.2 or older)
• Unpack the tarball
• Put the files somewhere in your project

To get started, add the following to your PHP script (if you are not running a framework):

<?php
require_once("PATH_TO_PAYPLUG/payplug_php/lib/init.php");

Usage

Here's how simple it is to create a payment request:

<?php
require_once("PATH_TO_PAYPLUG/payplug_php/lib/init.php"); // If not using a framework

// Loads your account's parameters that you've previously downloaded and saved
Payplug\Payplug::setSecretKey('YOUR_TOKEN');

// Create a payment request of €9.99. The payment confirmation (IPN) will be sent to "http://www.example.com/callbackURL"
$payment = Payplug\Payment::create(array(
        'amount'            => 999,
        'currency'          => 'EUR',
        'customer'          => array(
            'email'             => 'john.doe@example.com',
            'first_name'        => 'John',
            'last_name'         => 'Doe'
        ),
        'hosted_payment'    => array(
            'return_url'        => 'https://www.example.com/thank_you_for_your_payment.html',
            'cancel_url'        => 'https://www.example.com/so_bad_it_didnt_make_it.html'
        ),
        'notification_url'      => 'http://www.example.com/callbackURL'
));

// You will be able to find how the payment object is built in the documentation.
// For instance, if you want to get an URL to the payment page, you get do:
$paymentUrl = $payment->hosted_payment->payment_url;

// Then, you can redirect the user to the payment page
header("Location: $paymentUrl");
exit();

Go further:

Tests:

See tests/README.rst.