This section outlines the steps to install the Afterpay plugin on your Magento instance for the first time.
Magento can be installed in any folder on your server. For the purposes of this document, [MAGENTO]
will refer to the root folder where Magento is installed.
- The Afterpay plugin for Magento 1 is available as a
.zip
ortar.gz
file from the Afterpay GitHub repository - Unzip the file and copy everything in
/src/
to[MAGENTO]/
- Login to the Magento Admin and navigate to "System > Cache Management"
- Flush the cache storage by selecting Flush Cache Storage
Afterpay operates under a list of assumptions based on Magento configurations. To align with these assumptions, the Magento configurations must reflect the below.
-
Website Currency must be set to AUD, NZD, USD or CAD
Inside the Magento Admin, navigate to "System > Configuration > Currency Setup". Set the base, display and allowed currency as appropriate to match your Afterpay Merchant Account.
-
Postal Code must be mandatory
Inside the Magento Admin, navigate to "System > Configuration > General". Ensure Postal Code is not configured as optional for any country that Afterpay is being applied to.
To configure your Afterpay Merchant Account credentials in the Magento Admin, please complete the steps below. The prerequisite for this section is to obtain an Afterpay Merchant ID and Secret Key from Afterpay.
- Inside the Magento Admin, navigate to "System > Configuration > Sales > Payment Methods > Afterpay"
- Enter the Merchant ID and Merchant Secret Key (provided by Afterpay)
- Enable Afterpay by selecting "Yes" from the Enabled dropdown
- Configure the API Mode - select Sandbox for testing on a staging instance, or Production for a live website with legitimate transactions
- Save the configuration
- Click the Update Payment Limits button to retrieve the Minimum and Maximum Afterpay Order values
- Inside the Magento Admin, navigate to "System > Configuration > Sales > Afterpay"
- Enable Debug Mode to log transactions and additional valuable data
- Configure the display of the Afterpay elements presented on Product Detail Pages (PDP), the cart page and at the checkout
- After saving any changes, navigate to "System > Cache Management"
- Flush the cache storage by selecting Flush Cache Storage
This section outlines the steps to upgrade an existing installation of the Afterpay plugin to a new version.
The process of upgrading the Afterpay plugin for Magento 1 involves the complete removal of all plugin files, followed by copying the new files.
[MAGENTO]
will refer to the root folder where you have installed your version of Magento.
- Remove folder:
[MAGENTO]/app/code/community/Afterpay
- Remove folder:
[MAGENTO]/app/design/adminhtml/default/default/template/afterpay
- Remove file:
[MAGENTO]/app/design/frontend/base/default/layout/afterpay.xml
- Remove folder:
[MAGENTO]/app/design/frontend/base/default/template/afterpay
- Remove file:
[MAGENTO]/app/etc/modules/Afterpay_Afterpay.xml
- Remove folder:
[MAGENTO]/js/Afterpay
- Remove folder:
[MAGENTO]/skin/frontend/base/default/afterpay
- The Afterpay plugin for Magento 1 is available as a
.zip
ortar.gz
file from the Afterpay GitHub repository - Unzip the file and copy everything in
/src/
to[MAGENTO]/
- Login to the Magento Admin and navigate to "System > Cache Management"
- Flush the cache storage by selecting Flush Cache Storage