GoCardless for WooCommerce

Extends WooCommerce with a GoCardless gateway. A GoCardless merchant account is required.

Overview

This is a feature plugin for accepting payments via GoCardless. It requires WooCommerce to be installed before GoCardless for WooCommerce can be activated.

Compatibility

This extension is compatible with:

• Woo Subscriptions

Setup

Install the following plugins on your dev site:

• WooCommerce

Test account setup

You can create a user on gocardless.com for live transactions and on the sandbox for test transactions. When you first set up a site, you’ll be prompted to create a user for the correct GoCardless environment when setting up the webhooks.

Screenshots

Payment Methods screen	Default GoCardless configuration	Properly connected GoCardless configuration

Development

Requirements

• PHP: 7.4+
• WordPress: 6.8+
• WooCommerce: 10.7+
• Node: v24
• NPM: v11
• Composer: v2

Install dependencies & build

• nvm install - Ensures the required Node version is installed.
• npm install - Installs the necessary dependencies.
• npm run build - Creates a .zip archive containing the extension files for release or testing on other sites.
• npm run lint:js - Runs ESLint on JavaScript files.
• npm run test:unit - Executes PHPUnit tests.

Run E2E Tests

E2E tests are powered by Playwright running against a site provisioned by @wordpress/env.

Prerequisites

• Create a sandbox GoCardless account for test transactions.

Dependencies for Local Testing

• Add sandbox GoCardless credentials to the .env file, which can be found in the ./tests/e2e/config directory.

GOCARDLESS_EMAIL=********
GOCARDLESS_PASSWORD=********

Run E2E Tests Locally

1. Run npm install.
2. Run npx playwright install.
3. Run npm run env:install-plugins
4. Run npm run env:start (Note: Please start Docker before executing this command).
5. Add environment variables to the /tests/e2e/config/.env file (as mentioned above).
6. Run npm run test:e2e-local.

Run E2E Tests in the Pull Request

• Add the needs: e2e testing label to the pull request; it will initiate the E2E test GitHub action to run tests against the PR.