woocommerce-paypal-payments/README.md

<!-- WooCommerce logo -->
<p align="center">
  <a href="https://woocommerce.com/products/woocommerce-paypal-payments/">
    <img src="https://woocommerce.com/wp-content/themes/woo/images/logo-woocommerce@2x.png"
         alt="WooCommerce logo">
  </a>
</p>

<!-- PayPal logo -->
<p align="center">
  <a href="https://woocommerce.com/products/woocommerce-paypal-payments/">
    <img src="https://paypal.inpsyde.com/wp-content/uploads/sites/43/2025/05/PayPal-Logo-RGB-Black.png"
         alt="PayPal logo" height="130">
  </a>
</p>

[![License](https://img.shields.io/github/license/woocommerce/woocommerce-paypal-payments 'License')](https://github.com/woocommerce/woocommerce-paypal-payments/blob/trunk/LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/woocommerce/woocommerce-paypal-payments)](https://github.com/woocommerce/woocommerce-paypal-payments/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/woocommerce/woocommerce-paypal-payments)](https://github.com/woocommerce/woocommerce-paypal-payments/releases)
[![WordPress.org downloads](https://img.shields.io/wordpress/plugin/dt/woocommerce-paypal-payments.svg 'WordPress.org downloads')](https://wordpress.org/plugins/woocommerce-paypal-payments/advanced/#plugin-download-history-stats)
[![Build Status](https://github.com/woocommerce/woocommerce-paypal-payments/actions/workflows/php.yml/badge.svg?branch=trunk 'Build Status')](https://github.com/woocommerce/woocommerce-paypal-payments/blob/trunk/.github/workflows/php.yml)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/woocommerce/woocommerce-paypal-payments)

# WooCommerce PayPal Payments

PayPal's latest complete payments processing solution. Accept PayPal, Pay Later, credit/debit cards, alternative digital wallets local payment types and bank accounts. Turn on only PayPal options or process a full suite of payment methods. Enable global transaction with extensive currency and country coverage.

## Features  
  
- **Multiple Payment Options**: PayPal, credit/debit cards, Pay Later, digital wallets (Apple Pay, Google Pay), and localized payment methods  
- **Subscription Support**: Supports WooCommerce Subscriptions with PayPal Vaulting and PayPal Subscriptions  
- **Customizable Experience**: Flexible button placement and styling options  
- **Enhanced Security**: PCI compliance, 3D Secure, and fraud protection tools  
- **Global Compliance**: Meets international standards (PSD2, SCA)  
  
## Documentation  
  
Visit our [official documentation](https://woocommerce.com/document/woocommerce-paypal-payments/) for detailed guides and setup instructions.

## Dependencies

* PHP >= 7.4
* WordPress >= 6.5
* WooCommerce >= 9.6

## Quick Installation  
  
1. Go to **Plugins > Add New** in your WordPress admin  
2. Search for "WooCommerce PayPal Payments"  
3. Click "Install Now" and then "Activate"  
4. Go to **WooCommerce > Settings > Payments** to configure PayPal Payments

## Development

### Setup using DDEV (recommended)

You can install WooCommerce PayPal Payments locally using the dev environment of your preference, or you can use the DDEV setup provided in this repository. Which includes WordPress, WooCommerce and all development tools.

To set up the DDEV environment, follow these steps:

0. Install Docker and [DDEV](https://ddev.readthedocs.io/en/stable/).
1. Edit the [configuration](https://docs.ddev.com/en/stable/users/configuration/config/#managing-configuration) in the `.ddev/config.local.yml` file if needed. 
2. Run `$ ddev start && ddev orchestrate` to setup and orchestrate the plugin, WooCommerce and WordPress (you can also use `$ npm run ddev:setup`)
3. Open https://woocommerce-paypal-payments.ddev.site 

Use `$ ddev reset` for reinstallation (will destroy all site data).
You may also need `$ ddev restart` to apply the config changes.

#### Running tests and other tasks in the DDEV environment

Tests and code style:
- `$ ddev npm run test`
- `$ ddev npm run lint`
- `$ ddev npm run fix-lint`
- `$ ddev npm run lint-js`
- `$ npm run ddev:unit-tests:coverage`

See [package.json](/package.json) for other useful commands.

For debugging, see [the DDEV docs](https://ddev.readthedocs.io/en/stable/users/step-debugging/).
Enable xdebug via `$ ddev xdebug enable`, and press `Start Listening for PHP Debug Connections` in PHPStorm.
After creating the server in the PHPStorm dialog, you need to set the local project path for the server plugin path.
Check [this article](https://docs.ddev.com/en/stable/users/debugging-profiling/step-debugging/#phpstorm-debugging-setup) for a detailed guide.

## Setup in other environments

#### Install dependencies & build

- `$ composer install`
- `$ npm ci`

Optionally, change the `PAYPAL_INTEGRATION_DATE` constant to `gmdate( 'Y-m-d' )` to run the latest PayPal JavaScript SDK

#### Unit tests and code style

1. `$ ./vendor/bin/phpunit`
2. `$ ./vendor/bin/phpcs`
3. `$ ./vendor/bin/psalm`
4. `$ npm run lint-js`
5. `$ npm run test:unit-js` - Ensure node version is `18` or above

#### Unit tests with Coverage

Run `npm run ddev:unit-tests:coverage`

This command generates a full test coverage report, available at the URL https://woocommerce-paypal-payments.ddev.site/coverage

### Building a release package

If you want to build a release package, use the **Build package (New)** in GitHub Actions.

Currently, there is no script for building a proper release package locally, but you may try to run GHA locally via [nektos/act](https://github.com/nektos/act). 

## Test account setup

You will need a PayPal sandbox merchant and customer accounts to configure the plugin and make test purchases with it.

For setting up test accounts follow [these instructions](https://github.com/woocommerce/woocommerce-paypal-payments/wiki/Testing-Setup).

## Webhooks

For testing webhooks locally, follow these steps to set up ngrok:

0. Install [ngrok](https://ngrok.com/).

1.
  - If using DDEV, run our wrapper Bash script which will start `ddev share` and replace the URLs in the WordPress database:
    ```
    $ .ddev/bin/share
    ```

  - For other environments, run
    ```
    $ ngrok http -host-header=rewrite wc-pp.myhost
    ```
    and in your environment variables (accessible to the web server) add `NGROK_HOST` with the host that you got from `ngrok`, like `abcd1234.ngrok.io`. ngrok will be used only for the webhook listening URL.
The URLs displayed on the WordPress pages, used in redirects, etc. will still remain local.

2. Complete onboarding or resubscribe webhooks on the Webhooks Status page.

## License

[GPL-2.0 License](LICENSE)

## Contributing

All feedback / bug reports / pull requests are welcome.