afterpay-global/module-afterpay

Magento 2 Afterpay Payment Module

5.3.1 2024-03-12 09:09 UTC

Requires

• php: >=7.4.0
• afterpay-global/module-cash-app-pay: ^5
• magento/framework: ^103.0
• magento/module-checkout: 100.4.*
• magento/module-payment: 100.4.*
• magento/module-quote-graph-ql: 100.4.*
• magento/module-sales: 103.0.*
• magento/module-weee: 100.4.*

Apache-2.0

• Afterpay

README

Installation

Install using Composer (Recommended)

1. From the CLI, run the following commands to install the Afterpay module.
   The right installation command is dependent on your Magento 2 version:

   Magento version	Command to run
   2.4.*	composer require afterpay-global/module-afterpay:^5
   2.3.*	composer require afterpay-global/module-afterpay:^4
   < 2.3.0	composer require afterpay-global/module-afterpay:^3

2. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
3. Compile dependency injection: php bin/magento setup:di:compile
4. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
5. Flush Magento cache: php bin/magento cache:flush

Install manually

1. Download the Afterpay module for Magento 2 - Available as a .zip or tar.gz file from the Afterpay GitHub directory.
   The right installation module is dependent on your Magento 2 version:

   Magento version	Download
   2.4.*	Afterpay
   2.3.*	Afterpay:4.*
   < 2.3.0	Afterpay:legacy

2. Unzip the file
3. Create directory `Afterpay/Afterpay` in: [MAGENTO]/app/code/
4. Copy the files to `Afterpay/Afterpay` folder
5. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
6. Compile dependency injection: php bin/magento setup:di:compile
7. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
8. Flush Magento cache: php bin/magento cache:flush

Afterpay Merchant Setup

Complete the below steps to configure the merchant’s Afterpay Merchant Credentials in Magento Admin. Note: Prerequisite for this section is to obtain an Afterpay Merchant ID and Secret Key from Afterpay.

1. Navigate to Magento Admin/Stores/Configuration/Sales/Payment Methods/Afterpay
2. Enter the Merchant ID and Merchant Key.
3. Enable Afterpay plugin using the Enabled checkbox.
4. Configure the Afterpay API Mode (Sandbox Mode for testing on a staging instance and Production Mode for a live website and legitimate transactions).
5. Save the configuration.
6. Navigate to Magento Admin/System/Tools/Cache Management
7. Click Flush Magento Cache button

Upgrade

Composer Upgrade (Recommended)

This section outlines the steps to upgrade the currently installed Afterpay plugin version using composer.

Notes: Prerequisite for this section is that the module should be installed using composer. Please see section 'Install using Composer' for guidelines to install Afterpay module using composer.

[MAGENTO] refers to the root folder where Magento is installed.

1. Open Command Line Interface and navigate to the Magento directory on your server
2. In CLI, run the below command to update Afterpay module:
   The right installation command is dependent on your Magento 2 version:

   Magento version	Command to run
   2.4.*	composer require afterpay-global/module-afterpay:^5
   2.3.*	composer require afterpay-global/module-afterpay:^4
   < 2.3.0	composer require afterpay-global/module-afterpay:^3

3. Make sure that Composer finished the update without errors
4. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
5. Compile dependency injection: php bin/magento setup:di:compile
6. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
7. Flush Magento cache: php bin/magento cache:flush

Manual Upgrade

This section outlines the steps to upgrade the currently installed Afterpay plugin version.
The process of upgrading the Afterpay plugin version involves the complete removal of Afterpay plugin files.

Note: [MAGENTO] refers to the root folder where Magento is installed.

1. Remove Files in: [MAGENTO]/app/code/Afterpay/Afterpay
2. Download the Magento-Afterpay plugin - Available as a .zip or tar.gz file from the Afterpay GitHub directory.
   The right Afterpay module upgradation is dependent on your Magento 2 version:

   Magento version	Download
   2.4.*	Afterpay:latest
   2.3.*	Afterpay:4.*
   < 2.3.0	Afterpay:legacy

3. Unzip the file
4. Copy the files in folder to: [MAGENTO]/app/code/Afterpay/Afterpay
5. Open Command Line Interface
6. In CLI, run the command to enable Afterpay module: php bin/magento module:enable Afterpay_Afterpay
7. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
8. Compile dependency injection: php bin/magento setup:di:compile
9. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
10. Flush Magento cache: php bin/magento cache:flush

Uninstall

1. From the CLI, run the following commands to uninstall Afterpay module: bin/magento module:uninstall Afterpay_Afterpay
2. Run Magento install/upgrade scripts: php bin/magento setup:upgrade
3. Compile dependency injection: php bin/magento setup:di:compile
4. Deploy static view files (production mode only): php bin/magento setup:static-content:deploy
5. Flush Magento cache: php bin/magento cache:flush

Headless support

Module supports GraphQL and REST API. See GraphQL and Rest API