Enable TrueLayer for Magento

This guide assumes that you have already set up your TrueLayer account in Console. If you haven't, take a look at our Console configuration docs to learn how.

Before you start

This guide assumes that you already have:

• a Console account and client credentials
• a TrueLayer merchant account
• the correct webhook and redirect URIs for your webshop, uploaded to Console
• signing keys.

You need to set these up before you start working with the plugin itself.

🚧

Start in sandbox

Before moving any real money, make sure to test payments using sandbox credentials first. Check that General > Mode is set to Sandbox.

To access your Sandbox credentials in Console, ensure that the Live toggle in the top right is set to off.

1. Install the plugin using Composer

First, download and install Composer.

To install the plugin:

1. Download the latest TrueLayer Payments for Magento plugin from GitHub.
2. Run your SSH Console to connect to your Magento 2 store
3. Locate the root of your Magento 2 store.
4. Enter the command below in the command line of your root:

composer require truelayer/magento2

1. Composer downloads the extension for you.
   When it’s finished, clean the cache.
2. Deploy the content in your Magento environment using this command in your command line:

php bin/magento setup:upgrade
php bin/magento cache:clean

If Magento is running in production mode, deploy the static content below:

php bin/magento setup:static-content:deploy

1. Go to your Magento admin portal. Navigate to Stores > Configuration > Sales > Payment Methods > TrueLayer Payments.

2. Configure your settings in Magento

1. Under TrueLayer Payments, open the General tab.
2. Enter the credentials in the table below.

1. Go to the Settings tab of TrueLayer Payments in Magento. Enter this information in the appropriate fields:

1. Enable Debug Mode under Debug & Logging.
   This ensures that both you and TrueLayer receive useful information if an error occurs.