PayPal Payment Gateway Integration in Laravel

Recently I published an article PayPal Payment Gateway Integration in PHP. One of our readers asked about integrating the PayPal payment gateway in Laravel. Though Laravel is built using PHP, they have their own standards and flow. You have to adjust your core PHP code as per Laravel standards. In this article, I show you how to accept payment using PayPal on your Laravel application.

PayPal is one of the most trusted brands to accept online payment. PayPal provides different ways to integrate its payment system in web applications. One of the service is PayPal Rest API which we will use for this tutorial. For getting started, you first need to grab your client id and client secret.

Head over to your PayPal developer account and login into it. In the developer dashboard, click on the ‘My Apps & Credentials’ menu. Then click on the ‘Create App’ button under the REST API apps section.

Create PayPal REST API APP

Follow the steps as prompted and you will get your sandbox and live credentials. For now, copy the client id and client secret of sandbox mode. We should first test payments in sandbox mode and if it works then switch to live mode.

PayPal REST API app Sandbox Client Id and Client Secret

Basic Setup in Laravel to Accept Payment using PayPal

To integrate the PayPal system in Laravel, you need to perform certain steps.

  • Set up the environment required – install packages, store API credentials, etc.
  • Build a payment flow.
  • Store successful transactions in the database.

I am going to create a database table first to hold the transaction details. I’ll name the table as ‘payments’. Create a migration for the ‘payments’ table using the command:

php artisan make:migration create_payments_table

Open the migration file and specify the columns in the up() method.

<?php
...
...
public function up()
{
    Schema::create('payments', function (Blueprint $table) {
        $table->bigIncrements('id');
        $table->string('payment_id');
        $table->string('payer_id');
        $table->string('payer_email');
        $table->float('amount', 10, 2);
        $table->string('currency');
        $table->string('payment_status');
        $table->timestamps();
    });
}

Execute this migration using the command:

php artisan migrate

This command will create a ‘payments’ table in your database. Next, create a model corresponding to the ‘payments’ table.

php artisan make:model Payment

After this, add the PayPal credentials in your .env file.

PAYPAL_CLIENT_ID=PASTE_HERE_CLIENT_ID
PAYPAL_CLIENT_SECRET=PASTE_HERE_CLIENT_SECRET
PAYPAL_CURRENCY=USD

Clear the configuration cache using the command:

php artisan config:cache

For the sake of the tutorial, I have passed the ‘USD’ currency. The user can change the currency as per their requirements.

Now to build a PayPal payment flow, the system requires to have few routes. Let’s define them in the routes/web.php file.

<?php
...
...
Route::get('payment', 'PaymentController@index');
Route::post('charge', 'PaymentController@charge');
Route::get('success', 'PaymentController@success');
Route::get('error', 'PaymentController@error');

We will create PaymentController in the next steps.

PayPal Payment Gateway Integration in Laravel

Integrating payment gateways API in the application is quite complex stuff. Fortunately, Omnipay library made developer’s lives easy. Omnipay is the most popular payment processing library for PHP. It gives an easy and clean code for integrating different payment gateways. You don’t need to read payment gateway documentation thoroughly. All you need to do is use the code/system provided by Omnipay and you are done.

That being said, install Omnipay library using the command:

composer require league/omnipay omnipay/paypal

After this, create a controller PaymentController and define the methods mentioned in the route file.

php artisan make:controller PaymentController

The controller is responsible to initiate and complete the PayPal flow for your users.

  • Call the view.
  • Take the user inputs.
  • Process the amount towards PayPal.
  • Authorize the payment and charge the customer.
  • Insert transaction details into the database.

I am adding a code in the PaymentController which will perform all these steps.

PaymentController.php

<?php
  
namespace App\Http\Controllers;
  
use Illuminate\Http\Request;
use Omnipay\Omnipay;
use App\Models\Payment;
  
class PaymentController extends Controller
{
  
    private $gateway;
  
    public function __construct()
    {
        $this->gateway = Omnipay::create('PayPal_Rest');
        $this->gateway->setClientId(env('PAYPAL_CLIENT_ID'));
        $this->gateway->setSecret(env('PAYPAL_CLIENT_SECRET'));
        $this->gateway->setTestMode(true); //set it to 'false' when go live
    }
  
    /**
     * Call a view.
     */
    public function index()
    {
        return view('payment');
    }
  
    /**
     * Initiate a payment on PayPal.
     *
     * @param  \Illuminate\Http\Request  $request
     */
    public function charge(Request $request)
    {
        if($request->input('submit'))
        {
            try {
                $response = $this->gateway->purchase(array(
                    'amount' => $request->input('amount'),
                    'currency' => env('PAYPAL_CURRENCY'),
                    'returnUrl' => url('success'),
                    'cancelUrl' => url('error'),
                ))->send();
           
                if ($response->isRedirect()) {
                    $response->redirect(); // this will automatically forward the customer
                } else {
                    // not successful
                    return $response->getMessage();
                }
            } catch(Exception $e) {
                return $e->getMessage();
            }
        }
    }
  
    /**
     * Charge a payment and store the transaction.
     *
     * @param  \Illuminate\Http\Request  $request
     */
    public function success(Request $request)
    {
        // Once the transaction has been approved, we need to complete it.
        if ($request->input('paymentId') && $request->input('PayerID'))
        {
            $transaction = $this->gateway->completePurchase(array(
                'payer_id'             => $request->input('PayerID'),
                'transactionReference' => $request->input('paymentId'),
            ));
            $response = $transaction->send();
          
            if ($response->isSuccessful())
            {
                // The customer has successfully paid.
                $arr_body = $response->getData();
          
                // Insert transaction data into the database
                $payment = new Payment;
                $payment->payment_id = $arr_body['id'];
                $payment->payer_id = $arr_body['payer']['payer_info']['payer_id'];
                $payment->payer_email = $arr_body['payer']['payer_info']['email'];
                $payment->amount = $arr_body['transactions'][0]['amount']['total'];
                $payment->currency = env('PAYPAL_CURRENCY');
                $payment->payment_status = $arr_body['state'];
                $payment->save();
          
                return "Payment is successful. Your transaction id is: ". $arr_body['id'];
            } else {
                return $response->getMessage();
            }
        } else {
            return 'Transaction is declined';
        }
    }
  
    /**
     * Error Handling.
     */
    public function error()
    {
        return 'User cancelled the payment.';
    }
}

We have called a blade file in the index method. So, create a blade file called payment.blade.php and add code below in it.

<form action="{{ url('charge') }}" method="post">
    <input type="text" name="amount" />
    {{ csrf_field() }}
    <input type="submit" name="submit" value="Pay Now">
</form>

When we submit this form, control goes to the charge function in the PaymentController and controller processes the rest payment flow.

Test Payment in Sandbox Mode

While testing a payment, you require to add dummy card details to your PayPal sandbox account. You can get these dummy card details from your PayPal Developer Dashboard.

Upon login to the dashboard, head over to the Credit Card Generator from the left-side menu and generate dummy card details.

paypal-credit-card-generator

Make Payment Live

Once you are done with testing the transactions in the sandbox mode, you are ready to switch to production mode. To make your payment system live, update your live PayPal client id and client secret in the environment file.

Next, in the constructor method of a PaymentController, set the false value to the setTestMode() method.

$this->gateway->setTestMode(false);

Send Product Information to PayPal

In the previous steps, we are sending the amount to pay on PayPal. You may also want to send product information. The user can see these product details on the payment page before making a payment.

To send the product information, you need to pass the ‘items’ array to the purchase method as follows.

$response = $this->gateway->purchase(array(
    'amount' => $request->input('amount'),
    'items' => array(
        array(
            'name' => 'Course Subscription',
            'price' => $request->input('amount'),
            'description' => 'Get access to premium courses.',
            'quantity' => 1
        ),
    ),
    'currency' => env('PAYPAL_CURRENCY'),
    'returnUrl' => url('paymentsuccess'),
    'cancelUrl' => url('paymenterror'),
))->send();

Here I am passing the product details statically. You should make it dynamic depending on your flow.

I hope you got to know about PayPal payment gateway integration in Laravel. This tutorial should help you to add the PayPal flow to your Laravel application. It will allow you to receive online payments through PayPal.

Related Articles

If you liked this article, then please subscribe to our YouTube Channel for video tutorials.

25 thoughts on “PayPal Payment Gateway Integration in Laravel

  1. Hi Sajid, thanks for your answer!
    Everything is ok, but I receive this error:

    “Call to a member function completePurchase() on null ”
    Ii I dd(‘$this->gateway’)
    it prints null..

    Is this strange, what am I missing?

  2. Hi Sajid, thanks a lot for your nice tutorial!
    I followed the tutorial for Stripe payment too and because I need to implement both payments;
    I’m creating a unique PaymentController.
    I noticed a slight difference between the two tutorials, here you declare the “public $gateway;”
    before the function, in Stripe no.
    Which approach is better to follow?

    Thanks a lot for your support 🙂

    1. If you want to use both payments then use the different variables – $paypal_gateway, $stripe_gateway. Pass credentials to these variables in the constructor(like I did for PayPal). Then use a specific variable as per the payment option.

    1. try {
      $response = $this->gateway->purchase(array(
      ‘amount’ => $request->input(‘amount’),
      ‘items’ => array(
      array(
      ‘name’ => $request->input(‘category’),
      ‘price’ => $request->input(‘amount’),
      ‘description’ => ‘t-shirt’,
      ‘quantity’ => 1
      ),
      ),
      ‘currency’ => env(‘PAYPAL_CURRENCY’),
      ‘returnUrl’ => url(‘paymentsuccess’),
      ‘cancelUrl’ => url(‘paymenterror’),
      ))->send();

      if ($response->isRedirect()) {
      $response->redirect(); // this will automatically forward the customer

      } else {
      // not successful
      return $response->getMessage();
      }
      }

      1. InvalidArgumentException
        Empty number is invalid
        when
        $response = $this->gateway->purchase(array(
        ‘amount’ => $request->input(‘amount’),
        ‘items’ => array(
        array(
        ‘name’ => ‘Course Subscription’,
        ‘price’ => $request->input(‘amount’),
        ‘description’ => ‘Get access to premium courses.’,
        ‘quantity’ => 1
        ),
        ),
        ‘currency’ => env(‘PAYPAL_CURRENCY’),
        ‘returnUrl’ => url(‘paymentsuccess’),
        ‘cancelUrl’ => url(‘paymenterror’),
        ))->send();

    1. I run the command
      php artisan config:clear

      but the error continue
      Authentication failed due to invalid authentication credentials or a missing Authorization header.

      Is the laravel or ommipay version?

  3. helllo I am getting error,

    Authentication failed due to invalid authentication credentials or a missing Authorization header.

    1. When you added new constants in the environment file, you may sometimes need to clear configuration cache. You can do this by running the command:

      php artisan config:cache
  4. Authentication failed due to invalid authentication credentials or a missing Authorization header.

    I am getting this error please help

        1. this is because the paypal credentials couldnt get from the .env file… try
          $this->gateway->setClientId(‘client id’);
          $this->gateway->setSecret(‘secret id’);
          directly on the PaymentController and comment the previous things..thank me later

  5. Tbis is the first time I subscribe for a newsletter !
    Your articles are always straight to the point!
    Can you please write an article on how to integrate Stripe with Laravel?

Leave a Reply

Your email address will not be published.