For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Welcome
    • Business Hub
  • Platforms
    • Platforms Quickstart
      • Introduction
      • Getting Started
      • Install Extension
      • Configure Extension
      • Update Extension
    • Adyen
    • Ecwid
    • Shopify
    • Stripe
  • Afterpay Messaging
    • Getting Started
    • Implementation
    • Migration
    • Legacy Messaging Products
    • Launch Afterpay Info Modal Anywhere
  • API Development
    • API Quickstart
    • Test Environments
    • Certification
    • Disputes
    • Upgrade from API v1 to v2
  • SDK
    • iOS SDK
    • Android SDK
    • React Native SDK
    • PHP SDK
  • Marketing
    • Shop Directory
    • Brand Assets
LogoLogo
On this page
  • Overview
  • Composer
  • Manual Procedure
  • Download the Afterpay Extension
  • Run the Commands
  • Headless Support
PlatformsAdobe Commerce (Magento)

Adobe Commerce - Install Extension

Was this page helpful?
Previous

Configure Extension

Next
Built with

How Can I Install and Enable the Adobe Commerce Extension?

Overview

There are two ways to install and enable the Adobe Commerce Afterpay Extension:

  • Use Composer to automatically download and install the files it gets from Packagist. We recommend this method

  • Do a manual install

Both these ways involve locating and installing the Afterpay Extension for Adobe Commerce (Magento 2). Composer does this task automatically. For manual installations, you must locate and download these public repos for Adobe Commerce (Magento 2):

  • Afterpay Extension for Magento 2

  • Cash App Pay Extension for Magento 2 (US merchants only)

You can also use the “headless” methods, GraphQL and REST API. See the Headless Support section below.

Important

The Cash App Pay Extension only works for US merchants.

Composer

We recommend you use Composer to manage your repos and dependencies. This is a recommendation, not a requirement.

If you use Composer, make sure you install the correct module version that corresponds to your Adobe Commerce/Magento version. For example, module version 5.x works with Magento 2.4.x. The various modules and their corresponding Commerce/Magento version appear in this GitHub table. See Step 2 below.

Do the following:

  1. In Composer, open the Command Line Interface (CLI) and go to the Adobe Commerce project root directory on your server.

  2. In the CLI, run this command to install the Afterpay module: composer require afterpay-global/module-afterpay. See the GitHub table for the specific Afterpay module you need to specify.

  3. Make sure that Composer finishes the installation without errors.

  4. Run the Adobe Commerce setup upgrade: php bin/magento setup:upgrade.

  5. Run the Adobe Commerce Dependencies Injection Compile: php bin/magento setup:di:compile.

  6. Run the Adobe Commerce Static Content deployment: php bin/magento setup:static-content:deploy.

  7. Run the Adobe Commerce System Cache Flush: php bin/magento cache:flush.

Manual Procedure

This method does not use Composer. It is a more complex than using Composer, but just as effective when done correctly. Follow the instructions below.

Download the Afterpay Extension

The extension is on the GitHub. Do the following:

  1. Go to the GitHub for the link to Magento 2 for the most up-to-date version.
Note

The Afterpay plugins and associated information are all in the Afterpay-Magento-2 part of the GitHub.

The source code needed depends on your version of Magento. See the Readme file in the Afterpay-Magento-2 part of GitHub.

  1. Under the green <> Code heading, click HTTPS and click Download ZIP. See screenshot below:

    adobe-comm-manual-install.png

  2. Unzip your files and put them into a temporary folder.

📘 Install Folder

You can install Adobe Commerce in any folder on your server. In this guide, [ADOBE-COMMERCE] is the name of the root folder where Adobe Commerce is installed.

Run the Commands

  1. Create the folder Afterpay/Afterpay in [ADOBE-COMMERCE]/app/code.

  2. Copy the files from your temporary folder to the Afterpay/Afterpay folder. The temporary folder is the one you created in Step 3 in the Download the Afterpay Extension section above.

  3. Open the Command Line Interface (CLI) and make sure you are the owner of the [ADOBE-COMMERCE] folder. Run all the CLI commands as the owner of the folder, not root and without sudo.

  4. From the CLI, run the commands below:

CommandDescription
php bin/magento module:enable Afterpay_AfterpayEnable Afterpay extension.
php bin/magento setup:upgradeAdobe Commerce setup upgrade.
php bin/magento setup:di:compileAdobe Commerce dependencies injection compile.
php bin/magento setup:static-content:deployAdobe Commerce static content deployment.
php bin/magento cache:flushAdobe Commerce system cache flush.

Headless Support

You can also use GraphQL or the REST API to use Afterpay together with Adobe Commerce.

For details, see the following web pages on the GitHub:

  • Afterpay GraphQL Support page

  • REST API page