How to Implement PayPal Checkout with PayPal API in PHP

Set Up PayPal SDK

• First, ensure you have Composer installed, as it's required for integrating the PayPal SDK. If not, download and install Composer on your machine.

 

• To install the PayPal PHP SDK, run the following command in your terminal:

composer require paypal/rest-api-sdk-php

Configure PayPal Settings

• Create a configuration file or use your existing configuration to store your PayPal credentials. Ensure your `clientId` and `clientSecret` from the PayPal developer console are correctly stored in a secure manner.

 

• Below is an example of how you might set up your configuration using PHP arrays:

$config = [
    'clientId' => 'YOUR_CLIENT_ID',
    'clientSecret' => 'YOUR_CLIENT_SECRET',
    'settings' => [
        'mode' => 'sandbox', // Change to 'live' for production
        'http.ConnectionTimeOut' => 30,
        'log.LogEnabled' => true,
        'log.FileName' => '../PayPal.log',
        'log.LogLevel' => 'FINE'
    ]
];

Initialize PayPal API Context

• Next, set up the API context, necessary for making requests to the PayPal API. This context includes your credentials and configuration settings:

use PayPal\Rest\ApiContext;
use PayPal\Auth\OAuthTokenCredential;

$apiContext = new ApiContext(
    new OAuthTokenCredential(
        $config['clientId'],
        $config['clientSecret']
    )
);

$apiContext->setConfig($config['settings']);

Create a Payment

• To enable payments, you'll need to create a payment request specifying the amount, currency, and description of the payment. Below is an example of a typical payment object in PHP:

use PayPal\Api\Payer;
use PayPal\Api\Amount;
use PayPal\Api\Transaction;
use PayPal\Api\RedirectUrls;
use PayPal\Api\Payment;

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

// Set the payment amount
$amount = new Amount();
$amount->setTotal('10.00');
$amount->setCurrency('USD');

// Set up the transaction
$transaction = new Transaction();
$transaction->setAmount($amount);
$transaction->setDescription('Demo payment');

// Set the redirect URLs
$redirectUrls = new RedirectUrls();
$redirectUrls->setReturnUrl("http://example.com/your_redirect_url_here")
             ->setCancelUrl("http://example.com/your_cancel_url_here");

// Create the payment
$payment = new Payment();
$payment->setIntent('sale')
        ->setPayer($payer)
        ->setRedirectUrls($redirectUrls)
        ->setTransactions([$transaction]);

Execute Payment Creation

• To execute the payment creation and facilitate user redirection to PayPal for approval, run the following code. Ensure proper error handling to capture issues like failed API calls:

try {
    $payment->create($apiContext);
    $approvalUrl = $payment->getApprovalLink();

    // Redirect the user to PayPal for approval
    header("Location: " . $approvalUrl);
    exit;
} catch (Exception $e) {
    echo "Payment creation failed: " . $e->getMessage();
    // Log the error message in your error logs
}

Handle Payment Approval

• After the user approves the payment and is redirected back to your application, handle the returned `paymentId` and `PayerID` parameters to execute the payment:

use PayPal\Api\PaymentExecution;

// Retrieve the payment ID and payer ID from the query string
$paymentId = $_GET['paymentId'];
$payerId = $_GET['PayerID'];

// Get the payment and execute it
$payment = Payment::get($paymentId, $apiContext);
$execution = new PaymentExecution();
$execution->setPayerId($payerId);

try {
    $payment->execute($execution, $apiContext);
    echo "Payment successful!";
} catch (Exception $e) {
    echo "Payment execution failed: " . $e->getMessage();
    // Log the error for debugging
}

Additional Considerations

• Always test your PayPal integration in the sandbox environment to ensure everything is functioning correctly before moving to production.

 

• Implement robust error handling and logging throughout the process to capture any exceptions or API errors.

 

• Consider implementing webhooks for real-time updates on the payment status if your application requires it.