Guides
PHP

PHP SDK

⬇️

Check out our GitHub repository (opens in a new tab) to download this SDK.

This PHP SDK provides an easy method to integrate with the payment gateway.

  • The gateway.php file contains the main body of the SDK.

Prerequisites

  • The SDK requires the following prerequisites to be met in order to function correctly:
    • PHP 5.4+
    • SSL NB: HTTPS is expected to be in place when using direct integration as the payment gateway will respond over SSL. Failure to provide an environment where HTTPS traffic is possible, will result in the SDK failing*
⚠️

Please note that we can only offer support for the SDK itself. While every effort has been made to ensure the sample code is complete and bug free, it is only a guide and should not be used in a production environment.

Using the Gateway SDK

Include the source code and set the static fields Merchant ID and secret key.

require('gateway.php');
use \P3\SDK\Gateway;
Gateway::$merchantID = '100856';
Gateway::$merchantSecret = 'Circle4Take40Idea';

The other static public variables of the class can also be overridden if required, including support for HTTP proxying if required. Take a look at gateway.php to see the full method signatures. A request array that describes the transaction is then required. For example:

    $req = array(
        'merchantID' => 100001,
        'action' => 'SALE',
        'type' => 1,
        'currencyCode' => 826,
        'countryCode' => 826,
        'amount' => 1001,
        'cardNumber' => '4012001037141112',
        'cardExpiryMonth' => 12,
        'cardExpiryYear' => 15,
        'cardCVV' => '083',
        'customerName' => 'Test Customer',
        'customerEmail' => 'test@testcustomer.com',
        'customerAddress' => '16 Test Street',
        'customerPostCode' => 'TE15 5ST',
        'orderRef' => 'Test purchase',
        // The following fields are only mandatory for 3DS v2 direct integration
        'remoteAddress' => $_SERVER['REMOTE_ADDR'],
        'threeDSRedirectURL' => $pageUrl . '&acs=1'
    );

NB: This is a sample request. The gateway features many more options. Please see our PDF integration guide (opens in a new tab) for more details.

Then, depending on the integration method, you'd either call:

Gateway::directRequest($req);

OR

Gateway::hostedRequest($req);

And then handle the response received from the gateway.