paymentwall/paymentwall-php

Paymentwall PHP Library. Paymentwall is the leading digital payments platform for globally monetizing digital goods and services.

Installs: 2 987

Dependents: 2

Stars: 12

Watchers: 15

Forks: 21

Open Issues: 5

Language: PHP

1.2.0 2015-01-07 13:04 UTC

README

Paymentwall is the leading digital payments platform for globally monetizing digital goods and services. Paymentwall assists game publishers, dating sites, rewards sites, SaaS companies and many other verticals to monetize their digital content and services. Merchants can plugin Paymentwall's API to accept payments from over 100 different methods including credit cards, debit cards, bank transfers, SMS/Mobile payments, prepaid cards, eWallets, landline payments and others.

To sign up for a Paymentwall Merchant Account, click here.

Paymentwall PHP Library

This library allows developers to use Paymentwall APIs (Virtual Currency, Digital Goods featuring recurring billing, and Virtual Cart).

To use Paymentwall, all you need to do is to sign up for a Paymentwall Merchant Account so you can setup an Application designed for your site. To open your merchant account and set up an application, you can sign up here.

Installation

To install the library in your environment, you can download the ZIP archive, unzip it and place into your project.

Alternatively, you can run:

git clone git://github.com/paymentwall/paymentwall-php.git

Then use a code sample below.

Code Samples

Digital Goods API

Initializing Paymentwall

Using Paymentwall PHP Library v2:

require_once('/path/to/paymentwall-php/lib/paymentwall.php');
Paymentwall_Config::getInstance()->set(array(
    'api_type' => Paymentwall_Config::API_GOODS,
    'public_key' => 'YOUR_PUBLIC_KEY',
    'private_key' => 'YOUR_PRIVATE_KEY'
));

Using Paymentwall PHP Library v1 (deprecated in v2):

require_once('/path/to/paymentwall-php/lib/paymentwall.php');
Paymentwall_Base::setApiType(Paymentwall_Base::API_GOODS);
Paymentwall_Base::setAppKey('YOUR_APPLICATION_KEY'); // available in your Paymentwall merchant area
Paymentwall_Base::setSecretKey('YOUR_SECRET_KEY'); // available in your Paymentwall merchant area
Widget Call

Web API details

The widget is a payment page hosted by Paymentwall that embeds the entire payment flow: selecting the payment method, completing the billing details, and providing customer support via the Help section. You can redirect the users to this page or embed it via iframe. Below is an example that renders an iframe with Paymentwall Widget.

$widget = new Paymentwall_Widget(
    'user40012',   // id of the end-user who's making the payment
    'p1_1',        // widget code, e.g. p1; can be picked inside of your merchant account
    array(         // product details for Flexible Widget Call. To let users select the product on Paymentwall's end, leave this array empty
        new Paymentwall_Product(
            'product301',                           // id of the product in your system
            9.99,                                   // price
            'USD',                                  // currency code
            'Gold Membership',                      // product name
            Paymentwall_Product::TYPE_SUBSCRIPTION, // this is a time-based product; for one-time products, use Paymentwall_Product::TYPE_FIXED and omit the following 3 array elements
            1,                                      // duration is 1
            Paymentwall_Product::PERIOD_TYPE_MONTH, //               month
            true                                    // recurring
        )
    ),
    array('email' => 'user@hostname.com')           // additional parameters
);
echo $widget->getHtmlCode();
Pingback Processing

The Pingback is a webhook notifying about a payment being made. Pingbacks are sent via HTTP/HTTPS to your servers. To process pingbacks use the following code:

$pingback = new Paymentwall_Pingback($_GET, $_SERVER['REMOTE_ADDR']);
if ($pingback->validate()) {
  $productId = $pingback->getProduct()->getId();
  if ($pingback->isDeliverable()) {
  // deliver the product
  } else if ($pingback->isCancelable()) {
  // withdraw the product
  } 
  echo 'OK'; // Paymentwall expects response to be OK, otherwise the pingback will be resent
} else {
  echo $pingback->getErrorSummary();
}

Virtual Currency API

Initializing Paymentwall

Using Paymentwall PHP Library v2:

require_once('/path/to/paymentwall-php/lib/paymentwall.php');
Paymentwall_Config::getInstance()->set(array(
    'api_type' => Paymentwall_Config::API_VC,
    'public_key' => 'YOUR_PUBLIC_KEY',
    'private_key' => 'YOUR_PRIVATE_KEY'
));

Using Paymentwall PHP Library v1 (deprecated in v2):

require_once('/path/to/paymentwall-php/lib/paymentwall.php');
Paymentwall_Base::setApiType(Paymentwall_Base::API_VC);
Paymentwall_Base::setAppKey('YOUR_SECRET_KEY'); // available in your Paymentwall merchant area
Paymentwall_Base::setSecretKey('YOUR_SECRET_KEY'); // available in your Paymentwall merchant area
Widget Call
$widget = new Paymentwall_Widget(
    'user40012', // id of the end-user who's making the payment
    'p1_1',      // widget code, e.g. p1; can be picked inside of your merchant account
    array(),     // array of products - leave blank for Virtual Currency API
    array('email' => 'user@hostname.com') // additional parameters
);
echo $widget->getHtmlCode();
Pingback Processing
$pingback = new Paymentwall_Pingback($_GET, $_SERVER['REMOTE_ADDR']);
if ($pingback->validate()) {
  $virtualCurrency = $pingback->getVirtualCurrencyAmount();
  if ($pingback->isDeliverable()) {
  // deliver the virtual currency
  } else if ($pingback->isCancelable()) {
  // withdraw the virual currency
  } 
  echo 'OK'; // Paymentwall expects response to be OK, otherwise the pingback will be resent
} else {
  echo $pingback->getErrorSummary();
}

Cart API

Initializing Paymentwall

Using Paymentwall PHP Library v2:

require_once('/path/to/paymentwall-php/lib/paymentwall.php');
Paymentwall_Config::getInstance()->set(array(
    'api_type' => Paymentwall_Config::API_CART,
    'public_key' => 'YOUR_PUBLIC_KEY',
    'private_key' => 'YOUR_PRIVATE_KEY'
));

Using Paymentwall PHP Library v1 (deprecated in v2):

require_once('/path/to/paymentwall-php/lib/paymentwall.php');
Paymentwall_Base::setApiType(Paymentwall_Base::API_CART);
Paymentwall_Base::setAppKey('YOUR_APPLICATION_KEY'); // available in your Paymentwall merchant area
Paymentwall_Base::setSecretKey('YOUR_SECRET_KEY'); // available in your Paymentwall merchant area
Widget Call
$widget = new Paymentwall_Widget(
    'user40012', // id of the end-user who's making the payment
    'p1_1',      // widget code, e.g. p1; can be picked inside of your merchant account,
    array(
        new Paymentwall_Product('product301', 3.33, 'EUR'), // first product in cart
        new Paymentwall_Product('product607', 7.77, 'EUR')  // second product in cart
    ),
    array('email' => 'user@hostname.com') // additional params
);
echo $widget->getHtmlCode();
Pingback Processing
$pingback = new Paymentwall_Pingback($_GET, $_SERVER['REMOTE_ADDR']);
if ($pingback->validate()) {
  $products = $pingback->getProducts();
  if ($pingback->isDeliverable()) {
  // deliver products from the cart
  } else if ($pingback->isCancelable()) {
  // withdraw products from the cart
  } 
  echo 'OK'; // Paymentwall expects response to be OK, otherwise the pingback will be resent
} else {
  echo $pingback->getErrorSummary();
}

Brick

Initializing Paymentwall
Paymentwall_Config::getInstance()->set(array(
    'public_key' => 'YOUR_PUBLIC_KEY',
    'private_key' => 'YOUR_PRIVATE_KEY'
));
Create a one-time token
$tokenModel = new Paymentwall_OneTimeToken();
$token =  $tokenModel->create(array(
    'public_key' => Paymentwall_Config::getInstance()->getPublicKey(),
    'card[number]' => '4242424242424242',
    'card[exp_month]' => '11',
    'card[exp_year]' => '19',
    'card[cvv]' => '123'
));
Charge
$charge = new Paymentwall_Charge();
$charge->create(array(
    // if generated via backend
    //'token' => $token->getToken(),
    // if generated via brick.js
    'token' => $_POST['brick_token'],
    'email' => $_POST['email'],
    'currency' => 'USD',
    'amount' => 10,
    'fingerprint' => $_POST['brick_fingerprint'],
    'description' => 'Order #123'
));

$response = $charge->getPublicData();

if ($charge->isSuccessful()) {
    if ($charge->isCaptured()) {
        // deliver s product
    } elseif ($charge->isUnderReview()) {
        // decide on risk charge
    }
} else {
    $errors = json_decode($response, true);
    echo $errors['error']['code'];
    echo $errors['error']['message'];
}

echo $response; // need for JS communication
Charge - refund
$charge = new Paymentwall_Charge('CHARGE_ID');
$charge->refund();

echo $charge->isRefunded();
Subscription
$subscription = new Paymentwall_Subscription();
$subscription->create(array(
    // if generated via backend
    //'token' => $token->getToken(),
    // if generated via brick.js
    'token' => $_POST['brick_token'],
    'email' => $_POST['email'],
    'currency' => 'USD',
    'amount' => 10,
    'fingerprint' => $_POST['brick_fingerprint'],
    'plan' => 'product_123',
    'description' => 'Order #123',
    'period' => 'week',
    'period_duration' => 2
));

echo $subscription->getId();
Subscription - cancel
$subscription = new Paymentwall_Subscription('SUBSCRIPTION_ID');
$subscription->cancel();

echo $subscription->isActive();

Signature calculation - Widget

$widgetSignatureModel = new Paymentwall_Signature_Widget();
echo $widgetSignatureModel->calculate(
    array(), // widget params
    2 // signature version
);

Singature calculation - Pingback

$pingbackSignatureModel = new Paymentwall_Signature_Pingback();
echo $pingbackSignatureModel->calculate(
    array(), // pingback params
    1 // signature version
);