Integrate PayPal SDK into Laravel 4

PayPal has release an official SDK to simplify our work. Here I want to show you how to integrate into Laravel 4.

1. Install PayPal SDK via composer

Edit file composer.json

{
    ...
	"require": {
        ...
		"paypal/rest-api-sdk-php": "*"
	},
    ...
}

Update the dependencies

1	$ php composer.phar update --no-dev

You can now use the PayPal package in the project.

2. Configure PayPal

Add a config file for paypal: app/config/paypal.php

<?php
return array(
    // set your paypal credential
    'client_id' => 'AcT3DS8a-SmTEtSl9hNcwyscoLypndD9q5L0YcfxmaUavz3p_xwFNRE-OauO',
    'secret' => 'ENv8_RCXMfhcrzdSfAWjLWDiD_GJSD-Gbm5q2Pj92vIuobCtgLpR3SUxqAhZ',

    /**
     * SDK configuration 
     */
    'settings' => array(
        /**
         * Available option 'sandbox' or 'live'
         */
        'mode' => 'sandbox',

        /**
         * Specify the max request time in seconds
         */
        'http.ConnectionTimeOut' => 30,

        /**
         * Whether want to log to a file
         */
        'log.LogEnabled' => true,

        /**
         * Specify the file that want to write on
         */
        'log.FileName' => storage_path() . '/logs/paypal.log',

        /**
         * Available option 'FINE', 'INFO', 'WARN' or 'ERROR'
         *
         * Logging is most verbose in the 'FINE' level and decreases as you
         * proceed towards ERROR
         */
        'log.LogLevel' => 'FINE'
    ),
);

Setup in app/controllers/IndexController.php

<?php
use PayPal\Rest\ApiContext;
use PayPal\Auth\OAuthTokenCredential;
use PayPal\Api\Amount;
use PayPal\Api\Details;
use PayPal\Api\Item;
use PayPal\Api\ItemList;
use PayPal\Api\Payer;
use PayPal\Api\Payment;
use PayPal\Api\RedirectUrls;
use PayPal\Api\ExecutePayment;
use PayPal\Api\PaymentExecution;
use PayPal\Api\Transaction;

class IndexController extends BaseController
{
    ...
    private $_api_context;

    public function __construct()
    {
        ...
        // setup PayPal api context
        $paypal_conf = Config::get('paypal');
        $this->_api_context = new ApiContext(new OAuthTokenCredential($paypal_conf['client_id'], $paypal_conf['secret']));
        $this->_api_context->setConfig($paypal_conf['settings']);
    }
    ...
}

3. Add 2 routes for processing PayPal checkout

Add this to app/routes.php

<?php
Route::post('payment', array(
    'as' => 'payment',
    'uses' => 'IndexController@postPayment',
));

// this is after make the payment, PayPal redirect back to your site
Route::get('payment/status', array(
    'as' => 'payment.status',
    'uses' => 'IndexController@getPaymentStatus',
));

Update the controller, this method is when you submit the form or checkout shopping cart, then post to this route: app/controllers/IndexController.php

<?php
public function postPayment()
{
    ...

    $payer = new Payer();
    $payer->setPaymentMethod('paypal');

    $item_1 = new Item();
    $item_1->setName('Item 1') // item name
        ->setCurrency('USD')
        ->setQuantity(2)
        ->setPrice('15'); // unit price

    $item_2 = new Item();
    $item_2->setName('Item 2')
        ->setCurrency('USD')
        ->setQuantity(4)
        ->setPrice('7');

    $item_3 = new Item();
    $item_3->setName('Item 3')
        ->setCurrency('USD')
        ->setQuantity(1)
        ->setPrice('20');

    // add item to list
    $item_list = new ItemList();
    $item_list->setItems(array($item_1, $item_2, $item_3));

    $amount = new Amount();
    $amount->setCurrency('USD')
        ->setTotal(78);

    $transaction = new Transaction();
    $transaction->setAmount($amount)
        ->setItemList($item_list)
        ->setDescription('Your transaction description');

    $redirect_urls = new RedirectUrls();
    $redirect_urls->setReturnUrl(URL::route('payment.status'))
        ->setCancelUrl(URL::route('payment.status'));

    $payment = new Payment();
    $payment->setIntent('Sale')
        ->setPayer($payer)
        ->setRedirectUrls($redirect_urls)
        ->setTransactions(array($transaction));

    try {
        $payment->create($this->_api_context);
    } catch (\PayPal\Exception\PPConnectionException $ex) {
        if (\Config::get('app.debug')) {
            echo "Exception: " . $ex->getMessage() . PHP_EOL;
            $err_data = json_decode($ex->getData(), true);
            exit;
        } else {
            die('Some error occur, sorry for inconvenient');
        }
    }

    foreach($payment->getLinks() as $link) {
        if($link->getRel() == 'approval_url') {
            $redirect_url = $link->getHref();
            break;
        }
    }

    // add payment ID to session
    Session::put('paypal_payment_id', $payment->getId());

    if(isset($redirect_url)) {
        // redirect to paypal
        return Redirect::away($redirect_url);
    }

    return Redirect::route('original.route')
        ->with('error', 'Unknown error occurred');
}

PayPal summary

Up to this point, you will see the page above.

PayPal pay

Then login & pay.

4. Add another handler to handle PayPal after payment

Before that, when the payment successfully made, it will return this 2 parameters as query string

1 2	token=EC-05R25178G5276364N PayerID=LXA67A9A83UD6

Otherwise, ONLY token when the customer cancel the payment

1	token=EC-05R25178G5276364N

app/controllers/IndexController.php

<?php
public function getPaymentStatus()
{
    // Get the payment ID before session clear
    $payment_id = Session::get('paypal_payment_id');

    // clear the session payment ID
    Session::forget('paypal_payment_id');

    if (empty(Input::get('PayerID')) || empty(Input::get('token'))) {
        return Redirect::route('original.route')
            ->with('error', 'Payment failed');
    }

    $payment = Payment::get($payment_id, $this->_api_context);

    // PaymentExecution object includes information necessary 
    // to execute a PayPal account payment. 
    // The payer_id is added to the request query parameters
    // when the user is redirected from paypal back to your site
    $execution = new PaymentExecution();
    $execution->setPayerId(Input::get('PayerID'));
    
    //Execute the payment
    $result = $payment->execute($execution, $this->_api_context);

    echo '<pre>';print_r($result);echo '</pre>';exit; // DEBUG RESULT, remove it later

    if ($result->getState() == 'approved') { // payment made
        return Redirect::route('original.route')
            ->with('success', 'Payment success');
    }
    return Redirect::route('original.route')
        ->with('error', 'Payment failed');
}

See the DEBUG RESULT there, if you print it out, the output will be

You have done.

Update Dec 17, 2014

If you have problem with live credentials, please read through this section

PayPal credential step 1

Click on Dashboard link

2. Edit your app

PayPal credential step 2

Under My apps, click on the app you wanted to use in your project

3. Get the live credentials

PayPal credential step 3

Scroll down after the Add webhook button, click on the Show link

PayPal credential step 4

Then edit app/config/paypal.php, replace client_id & secret with the live credentials, and change the mode to live

Ack: Thanks waiylgeek for the info.

Update Jan 19, 2015. READ ME:

My intention of this post is about to share how to integrate PayPal official SDK to Laravel 4.
I’m not a PayPal expert here, those PayPal api, PayPal rules, etc question please refer to PayPal official website.

If you have any feedback or improvement, welcome to comment on this post, or drop me an email.

Thank you.

Integrate PayPal SDK into Laravel 4

Integrate PayPal SDK into Laravel 4

1. Install PayPal SDK via composer

2. Configure PayPal

3. Add 2 routes for processing PayPal checkout

4. Add another handler to handle PayPal after payment

Update Dec 17, 2014

1. Login to PayPal developer portal

2. Edit your app

3. Get the live credentials

Ack: Thanks waiylgeek for the info.

Update Jan 19, 2015. READ ME: