PayPal | EasyStore - Documentation | JoomShaper

EasyStore

Updated Last: 02 February 2026

PayPal

EasyStore offers seamless integration with PayPal, one of the world's most trusted payment gateways. With this integration, you can securely process payments for your online store. 

Check out the list of countries and currencies supported by PayPal.

Adding PayPal to Your Payment Options

  1. Log in to your Joomla Dashboard and navigate to Components > EasyStore > Settings > Payments.
  2. Within Payment Settings, locate the “Add Payment Method” button and click on it.
  3. From the list of available payment methods, choose PayPal and click on the “Add” button.
  4. This action will successfully add Paypal to the list of available payment options for your store.

Configuring PayPal Integration

After adding PayPal as your preferred payment method, locate the newly added option in the list and click on the "Setup" button next to it.

PayPal Payment Integration for EasyStore

Clicking on the "Setup" button will trigger a popup screen to appear, allowing you to configure the PayPal plugin for seamless integration with your store's checkout process.

PayPal Payment Gateway Integration for EasyStore

Title

Give your PayPal integration a title (e.g., "PayPal"). This user-defined title helps you identify this integration within your Joomla Dashboard.

Payment Environment

Choose between the "Production" or "Sandbox" payment environment depending on whether you want to test payments in a demo environment or process real transactions in a live environment.

Sandbox / Production Merchant Email

Enter the email address associated with your PayPal account. Select "sandbox" for test emails and "production" for live emails. This is where payment notifications and transaction details will be sent.

How to Obtain Your Sandbox/Production Credentials

PayPal Payment Gateway Integration for EasyStore

You can retrieve your sandbox and production account credentials by logging into your PayPal Developer dashboard. From there, use the Sandbox and Live toggle buttons to switch between environments. 

To obtain your Merchant Account Credentials or Keys, you must have a registered merchant account with PayPal. Once registered, switch this option to "Live" and follow the steps to retrieve your credentials.

How to Obtain Sandbox Client Secret Key and Sandbox Client ID

  • Visit https://developer.paypal.com/home/ and login to your account. If you don’t have an account then sign up for one here.
  • Once you have logged in, from your Developer dashboard, click on the Apps & Credentials tab.
PayPal Payment Integration for EasyStore
  • Click the "Create App" button located on the mid-right side of your screen to begin creating an App. Enter the app name, select the type, add the sandbox account (email of the sandbox account), and click "Create App."
Paypal Payment Integration for EasyStore
  • In your Apps and Credentials dashboard, you’ll find your created app along with the associated Client ID and Secret Key. Use these keys to integrate the PayPal payment gateway in EasyStore.
PayPal Payment Gateway Integration for EasyStore

How to Obtain Sandbox / Merchant Webhook ID

You can obtain the webhook ID in two ways: From EasyStore's PayPal Payment Gateway setup interface or manually from the PayPal Developer dashboard.

This is the most efficient method as it automatically configures the required settings in PayPal.

Prerequisites

  • Ensure you have already retrieved and saved your Client Secret Key and Sandbox Client ID from PayPal.

Steps

  1. Navigate to the EasyStore PayPal integration setup interface.
  2. Enter your PayPal credentials and configuration details.
  3. Click the "Create Webhook" button.
    PayPal Payment Gateway Integration for EasyStore
  4. If the information provided is correct, the webhook will be automatically generated with the necessary settings.

Method 2: Manual Webhook Configuration

Follow these steps if you prefer to manually configure your webhook within the PayPal Developer Dashboard.

1. Create the Webhook

  1. Log in to the PayPal Developer Dashboard.

  2. Navigate to the Apps & Credentials tab.

  3. Scroll down to the Sandbox Webhooks section and click "Add Webhook".
    PayPal Payment Gateway Integration for EasyStore

2. Configure the Webhook URL

PayPal Payment Gateway Integration for EasyStore

In the Webhook URL field, enter your site-specific endpoint:

https://www.yourDomain.com/index.php?option=com_easystore&task=payment.onPaymentNotify&type=paypal

Note: Replace yourDomain.com with your actual website domain.

3. Select Event Types

To ensure correct payment processing, you must only select the following two event types:

  • Checkout order approved
  • Payment capture completed

    Warning: Selecting additional events may cause integration issues or incorrect payment processing.

4. Finalize and Integrate

  1. Click Save to generate your Webhook ID.
  2. Copy the generated Webhook ID and paste it into the EasyStore PayPal payment gateway settings to complete the integration.
PayPal Payment Gateway Integration for EasyStore

Payment Instruction

If needed, supply your customers with any payment instructions or supplementary information. This could encompass details on completing a payment or any special instructions regarding PayPal payments.

After configuring the above settings, click Save & Close to save the integration. To make the PayPal payment method available for your online store, you need to add it to your list of payment methods from EasyStore > Settings > Payments. Learn more.