PHPackages                             craftcms/commerce-paypal - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. craftcms/commerce-paypal

Abandoned → [craftcms/commerce-paypal-checkout](/?search=craftcms%2Fcommerce-paypal-checkout)Craft-plugin[Payment Processing](/categories/payments)

craftcms/commerce-paypal
========================

PayPal integration for Craft Commerce 3.3+

3.0.0(5y ago)622.9k9[5 issues](https://github.com/craftcms/commerce-paypal/issues)[2 PRs](https://github.com/craftcms/commerce-paypal/pulls)MITPHPCI passing

Since Apr 3Pushed 2y ago5 watchersCompare

[ Source](https://github.com/craftcms/commerce-paypal)[ Packagist](https://packagist.org/packages/craftcms/commerce-paypal)[ RSS](/packages/craftcms-commerce-paypal/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (9)Used By (0)

PayPal for Craft Commerce
=========================

[](#paypal-for-craft-commerce)

This plugin provides [PayPal](https://www.paypal.com/) integrations for [Craft Commerce](https://craftcms.com/commerce), including PayPal Pro, PayPal Express Checkout, and PayPal REST.

Credit card payments with the REST gateway are supported only in the US and UK.

Deprecation Notice
------------------

[](#deprecation-notice)

PayPal has deprecated PayPal Express as a checkout flow. They have advised that projects should look to implement the [PayPal Checkout](https://developer.paypal.com/docs/archive/checkout/integrate/) integration to keep up to date. Therefore this plugin is now deprecated in favour of the new [Commerce PayPal Checkout Plugin](https://github.com/craftcms/commerce-paypal-checkout).

Requirements
------------

[](#requirements)

This plugin requires Craft 3.6 and Craft Commerce 3.3 or later.

Installation
------------

[](#installation)

You can install this plugin from the Plugin Store or with Composer.

#### From the Plugin Store

[](#from-the-plugin-store)

Go to the Plugin Store in your project’s Control Panel and search for “PayPal for Craft Commerce”. Then click on the “Install” button in its modal window.

#### With Composer

[](#with-composer)

Open your terminal and run the following commands:

```
# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require craftcms/commerce-paypal

# tell Craft to install the plugin
./craft install/plugin commerce-paypal
```

Setup
-----

[](#setup)

To add a PayPal payment gateway, go to Commerce → Settings → Gateways, create a new gateway, and set the gateway type to either “PayPal Pro”, “PayPal REST” or “PayPal Express”.

> **Tip:**PayPal Express API Username, API Password, and API Signature settings can now be set to environment variables. PayPal Pro API Username, API Password, and API Signature settings can now be set to environment variables. PayPal REST Client ID and Secret settings can now be set to environment variables. See [Environmental Configuration](https://docs.craftcms.com/v3/config/environments.html) in the Craft docs to learn more about that.

### Finding your PayPal Express Credentials

[](#finding-your-paypal-express-credentials)

1. Log in to your PayPal Seller Account
2. In the top menu bar click "Profile" and choose "Profile and Settings"
3. Click "My Selling Preferences"
4. Click "API Access" (click "update")
5. You want the the NVP/SOAP API Integration (Classic) section
6. Then go to "Manage API credentials"
7. If you don't have any credentials already then generate some.

Matching the different bits of info up to the fields within the gateway setup can be tricky as sometimes the labels change. This table should help.

Gateway labelSandbox Account/AccountAPI UsernameSandbox Account/AccountAPI PasswordClient IDAPI SignatureSecret (click 'Hide' to show it - totally logical)Solution TypeMarkLanding PageDetermines the type of form the user gets at PayPalIn the gateway settings there is also a dropdown for "Solution Type". We *think* it may be the difference between personal and business PayPal accounts. In my case “Mark” worked, “Solo” didn’t.

"Landing Page" controls the type of form that is shown when the customer gets directed to PayPal. Selecting "Billing" will show a set of Credit Card fields with an option to login to PayPal (from memory this is a bit hidden). Selecting "Login" presents a PayPal login form without any credit card fields.

Brand Name, Header Image URL, Logo Image URL, and Border Colour are all customisation options for your landing page. Use the full URL to your image assets, including the domain.

### Important

[](#important)

If you're going to use the PayPal Express payment gateway you are required to change the default value of `tokenParam` in your [Craft config](https://docs.craftcms.com/api/v3/craft-config-generalconfig.html#$tokenParam-detail)

Choose any different token name other than `token`, for example you could put `craftToken`. Otherwise redirects from PayPal will fail.

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance3

Infrequent updates — may be unmaintained

Popularity32

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~222 days

Recently: every ~215 days

Total

6

Last Release

1854d ago

Major Versions

1.0.0.1 → 2.0.02019-03-04

2.1.0.1 → 3.0.02021-04-20

### Community

Maintainers

![](https://www.gravatar.com/avatar/3ccdf8b493035de2343c55bd889513e3af5c04d5823482a2b186ad16adb1c3e3?d=identicon)[brandonkelly](/maintainers/brandonkelly)

---

Top Contributors

[![andris-sevcenko](https://avatars.githubusercontent.com/u/1891118?v=4)](https://github.com/andris-sevcenko "andris-sevcenko (32 commits)")[![lukeholder](https://avatars.githubusercontent.com/u/133571?v=4)](https://github.com/lukeholder "lukeholder (10 commits)")[![angrybrad](https://avatars.githubusercontent.com/u/61869?v=4)](https://github.com/angrybrad "angrybrad (9 commits)")[![brandonkelly](https://avatars.githubusercontent.com/u/47792?v=4)](https://github.com/brandonkelly "brandonkelly (6 commits)")[![nfourtythree](https://avatars.githubusercontent.com/u/266453?v=4)](https://github.com/nfourtythree "nfourtythree (2 commits)")[![timkelty](https://avatars.githubusercontent.com/u/18329?v=4)](https://github.com/timkelty "timkelty (2 commits)")[![boboldehampsink](https://avatars.githubusercontent.com/u/378974?v=4)](https://github.com/boboldehampsink "boboldehampsink (1 commits)")[![benjamindavid](https://avatars.githubusercontent.com/u/2911900?v=4)](https://github.com/benjamindavid "benjamindavid (1 commits)")[![MakeilaLundy](https://avatars.githubusercontent.com/u/19892516?v=4)](https://github.com/MakeilaLundy "MakeilaLundy (1 commits)")

---

Tags

craft-commercecraft-plugincraftcmspaypalyii2paypalomnipaycraftcmscommerce

### Embed Badge

![Health badge](/badges/craftcms-commerce-paypal/health.svg)

```
[![Health](https://phpackages.com/badges/craftcms-commerce-paypal/health.svg)](https://phpackages.com/packages/craftcms-commerce-paypal)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
