Installation

Install the Buckaroo plugin with Composer, then verify it before you configure anything.

Before you begin

You need:

• A Buckaroo account. Sign up here if you don't have one. You can install and test the plugin while your application is being reviewed.
• Magento 2.4.7 to 2.4.9 (Open Source, Adobe Commerce, or Adobe Commerce Cloud).
• PHP 8.1 to 8.5.
• Composer 2.x installed, and command-line access to your Magento root directory.
• Magento cron running. The plugin uses cron for scheduled work such as Second Chance emails and cancelling expired orders. If cron isn't running, some features silently do nothing. See Configure and run cron.

Install

We recommend Composer. It makes installing, updating and maintaining the plugin straightforward, and it's the method these instructions assume.

Run the following in your Magento root directory:

composer require buckaroo/magento2
php bin/magento module:enable Buckaroo_Magento2
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:flush

If your store is in developer mode you can skip setup:di:compile and setup:static-content:deploy.

To install a specific major version rather than the latest:

composer require buckaroo/magento2:^2.0

All released versions are listed on the releases page.

Verify the installation

Confirm the module is registered and enabled:

php bin/magento module:status Buckaroo_Magento2

You should see the module listed as enabled. You should also now see a Buckaroo entry under Stores → Configuration → Sales in the Magento admin.

Upgrade

Update regularly. New payment methods, scheme-mandated changes and security fixes all arrive through releases. Read the release notes before upgrading, especially across a major version.

composer update buckaroo/magento2
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento cache:flush

Server configuration

Full-page cache and Varnish

The plugin marks its own checkout and payment blocks as non-cacheable, so a standard Magento + Varnish setup needs no extra configuration.

If you run a custom caching layer or CDN in front of Magento that doesn't respect Magento's cache headers, exclude the plugin's routes. They all sit under the buckaroo front name:

/buckaroo/*

Firewall and IP allowlisting

Buckaroo sends push messages to your store to confirm payment results. If a firewall, WAF or IP allowlist blocks them, payments will succeed at Buckaroo while your orders sit in "Pending payment".

Allow inbound traffic from Buckaroo's push addresses and ports. See Push messages for the current list.

You don't need to configure a push URL anywhere: the plugin sends it with each transaction. There is more on this in Connect your Buckaroo account.

Staging environments behind basic authentication will also reject pushes.

Multi-store setups

The plugin supports configuration at website and store-view scope. If you run multiple brands or countries from one Magento installation, you can use a different Buckaroo Store key per store view while sharing one Secret key across the account. See Connect your Buckaroo account.

Uninstall

Run the following from your Magento root directory:

php bin/magento module:disable Buckaroo_Magento2
composer remove buckaroo/magento2
php bin/magento setup:upgrade
php bin/magento cache:flush

Disabling the module leaves historical order and transaction data in place.