Install Payment Services
Downloading and installing the Payment Services extension for Adobe Commerce and Magento Open Source is a prerequisite step for using Payment Services.
Download the extension
You must first download the extension from Commerce Marketplace before installing it.
- Navigate to the Payment Services extension in the Commerce Marketplace.
- To choose the edition and version, toggle Edition and Your store version to your preferred selections.
- Click Add to Cart.
- Complete checkout and click Place Order.
- Check the email associated with your Marketplace download for order confirmation and details.
Install the extension
You can install the Payment Services extension for both Adobe Commerce on cloud infrastructure and on-premises instances, which are linked to your Commerce account mageid provided in the signup process. Magento Open Source customers use the on-premises instructions.
Composer uses these keys during the initial installation of Adobe Commerce, or in situations in which the Composer keys were not previously saved to the auth.json
file.
See Get your authentication keys for more information about obtaining Composer keys.
See Install an extension for more information about what to consider before downloading and installing an extension.
Adobe Commerce on cloud infrastructure
This method is used for installing the Payment Services extension for a Commerce Cloud instance.
-
Update your
composer.json
file:code language-bash composer require magento/payment-services --no-update
-
Update dependencies and install the extension:
code language-bash composer update magento/payment-services --with-dependencies
Use the
composer update
command to update all root dependencies. -
Commit and push your changes.
On-premises and other configurations
This method is used for installing the Payment Services extension for an on-premises instance and Magento Open Source customers.
-
To obtain the extension, run these commands:
code language-bash composer require magento/payment-services --no-update
-
Update dependencies and install the extension:
code language-bash composer update magento/payment-services --with-dependencies
Use the
composer update
command to update all root dependencies. -
Upgrade your instance:
code language-bash bin/magento setup:upgrade
-
Clear the cache:
code language-bash bin/magento cache:clean
-
Commit changes.
-
To ensure that the committed code is deployed, update your instance .
Upgrade the extension
When a new version of Payment Services is released, you can easily upgrade your extension.
-
To obtain the most recent version of the package:
code language-bash composer update magento/payment-services --with-dependencies
Use the
composer update
command to update all root dependencies. -
Commit and push your changes.
Troubleshooting
You may see errors when attempting to install the Payment Services extension. Use the following troubleshooting methods to resolve the errors.
Incorrect Composer keys
If you see the following error denoting that you have the incorrect Composer keys:
Could not find a matching version of package magento/payment-services. Check the package spelling, your version constraint and that the package is available in a stability which matches your minimum-stability (stable).
Verify that your Composer keys are valid and you have access to other Magento packages.
To see which Composer keys are configured:
-
Find the location of the
auth.json
file:code language-bash composer config --global home
-
View the
auth.json
file:code language-bash cat /path/to/auth.json
-
See which keys are associated with your Commerce account
MageID
.
Not enough memory for PHP
If you see the following error denoting you do not have enough memory for PHP:
Fatal error: Allowed memory size of 2146435072 bytes exhausted (tried to allocate 4096 bytes) in phar:///usr/local/bin/composer/src/Composer/DependencyResolver/RuleWatchGraph.php on line 52
Increase the memory limit for PHP on your environment in php.ini
.
Alternatively, you can specify the memory limit using this command: php -d memory_limit=-1 [path to composer]/composer require magento/payment-services
.
For example:
php -d memory_limit=-1 vendor/bin/composer require magento/payment-services