Payment extension for Aimeos web shops and e-commerce solutions


Aimeos logo

Build Status Coverage Status Scrutinizer Code Quality HHVM Status

Aimeos extension for additional payment methods and their service provider. Some of them may have beta quality and improvements or contributions are always welcome!

Tip: There's also commercial support available if you need help to get a specific provider working.

Table of contents


As every Aimeos extension, the easiest way is to install it via composer. If you don't have composer installed yet, you can execute this string on the command line to download it:

php -r "readfile('');" | php -- --filename=composer

Add the cache extension name to the "require" section of your composer.json (or your composer.aimeos.json, depending on what is available) file:

"require": [
    "aimeos/ai-payments": "dev-master",

You should use a stable release if you don't want to add code or improve the implementation. The available stable versions can be found on Packagist.

Afterwards you only need to execute the composer update command on the command line:

composer update

If your composer file is named "composer.aimeos.json", you must use this:

COMPOSER=composer.aimeos.json composer update

These commands will install the Aimeos extension into the extension directory and it will be available immediately.


Payment options are configured via the shop administration interface in the "Service" tab and you can add as many payment options as you need to the list for each site. They will be shown on the payment page in the checkout process. In the detail view of a new payment option, you have to enter some values:

Aimeos payment detail view

Make sure you set the status to "enabled" and the type to "Payment". Use an unique code for the payment option, idealy it should be readable and consist only of characters a-z, 0-9 and a few special characters like "-", "_" or ".". The value for the field "Provider" must be the last part of the class name of the payment service provider. Each of the following sections will tell you how it must be named. The last input field influences the position of the payment option within the list of payment options and you should use zero for the top position and greater values for the next payment options.

In the right side of the panel you can add the configuration settings that are specifically required for each payment provider. The list of available settings for each payment provider can be found in the service documentation.


The Aimeos payments extension is licensed under the terms of the LGPLv3 Open Source license and is available for free.