Introduction
This guide describes the steps to test and activate AfterPay in your Magento 2 store. For testing, you need the testaccounts sent to you by AfterPay.
Check SOAP support
In order to use AfterPay, your server needs to support SOAP. If you’re not sure about this, you can check this in your PHP settings using this PHP info file (zip). Upload this to your server and access it in your browser.
Install the extension
You can install the extension through SSH, using composer.
1) change the directory to project root/ folder, and run the following command to install and update the AfterPay module and dependencies:
composer require afterpay/afterpay-module
2) Upgrade and flush Magento cache
php bin/magento setup:upgrade php bin/magento cache:flush
More detailed instructions and release notes can be found here: https://bitbucket.org/afterpay-plugins/afterpay-magento-2
The instructions how to update from an old version of the AfterPay module can be found here.
Configure payment methods
Navigate to Stores -> Configuration -> Sales -> Payment Methods.
The AfterPay payment methods are split per country.
Note:
For SOAP connection you will be provided with a Merchant ID, Portfolio ID and Password.
For REST connections you will be provided with an API key. There are designated payment methods for REST connections – Digital Invoice (REST).
For each AfterPay payment method you have a contract for, configure the options with the values as shown below. You need the account details as sent by AfterPay.
1) Enable the method
2) Fill in the maximum order value
3) Set Connection Mode to Test
4) For REST connections fill in the API key. Please choose the Connection type (Sandbox, Test, Production) and fill the corresponding API key.
For SOAP Connection fill in the Merchant ID, Portfolio ID and Password for test.
Tax classes mapping
AfterPay expect all amounts to be sent including vat. Then, using vat categories, the vat amount is calculated on AfterPay side. For this to work correctly, the Magento tax classes need to be mapped to the corresponding AfterPay vat category.
1) Open the AfterPay Tax Settings option (below the payment methods)
2) Map each Magento Tax class to the correct VAT category. In the example below, the default Taxable Goods class is used as the high tax class in Magento (21%), so it is mapped to the AfterPay High category.
Notes:
- You can map multiple Magento tax classes to a single AfterPay vat category, but you should not map a single Magento tax class to multiple AfterPay vat categories
- If you have a separate class for shipping, please remember to map it also. You can use the CTRL key to select multiple tax classes
Submit testorders
To check the submission of successful orders, place an testorder for each payment method with:
- multiple products
- discount (if possible)
- shipping fee (if possible)
- service fee (if allowed)
- alternate delivery address
Below you will find the testdata that can be used.
| Field | Value |
|---|---|
| Gender | M |
| First name | Test |
| Last name | Acceptatie |
| [your e-mailadres] | |
| Telephone | 0513744112 |
| Zip code | 8443ER |
| Housenumber | 1 |
| Streetname | Teststraat |
| City | Testplaats |
| Country | Nederland |
| Date of birth | January 1st 1990 |
| Field | Value |
|---|---|
| Gender | M |
| First name | Test |
| Last name | Acceptatie |
| [your e-mailadres] | |
| Telephone | 0513744112 |
| Zip code | 8443ER |
| Housenumber | 1 |
| Streetname | Teststraat |
| City | Testplaats |
| Country | Nederland |
| Date of birth | January 1st 1990 |
| Bankaccount | NL93RABO0170100200 |
| Field | Value |
|---|---|
| First name | T |
| Last name | Acceptatie |
| [your e-mailadres] | |
| Telephone | 0513744112 |
| Zip code | 8443ER |
| Housenumber | 1 |
| Streetname | Teststraat |
| City | Testplaats |
| Country | Nederland |
| Company | Testbedrijf |
| COC number | 56583052 |
| Field/th> | Value |
|---|---|
| Gender | M |
| First name | Gert |
| Last name | Verhulst |
| [your e-mailadres] | |
| Telephone | 025882956 |
| Zip code | 1234 |
| Housenumber | 1 |
| Streetname | Hoofdstraat |
| City | Antwerpen |
| Country | België |
| Date of Birth | 16-07-1986 |
AfterPay logo & banner
Below you will find the AfterPay logo and banner.
Looking for a different size? Simply click on the logo or banner and see all sizes available.
Please add the AfterPay logo on all places where payment method logo’s are shown
No logo’s of payment methods? Then you can skip this part.
The banner is a great way of showing AfterPay is now a payment option in your shop!
*All log’s have transparency, the white logo can be used in places where the background color is dark.
 |
M: 113 x 22 | download PNG |
 |
M: 113 x 22 | download PNG |
*The banners are as is, no transparency, white is actually the color white.
 |
AfterPay information
For each payment method, please place the explanation somewhere on your webshop. Usually, this is the page where you sum up the available payment methods.
Below you will find the text, that you can copy and paste into your webshop.
Replace the variables where needed:
– [webshop url] = the URL of your webshop
AfterPay – Achteraf betalen voor consumenten (NL/BE)
AfterPay voert voor [webshop url] het volledige achteraf betaalproces uit. Wanneer je je bestelling afrondt via AfterPay ontvang je van hen een digitaal betaaloverzicht en betaal je het orderbedrag aan AfterPay. Ter goedkeuring van je verzoek om achteraf te betalen voert AfterPay een gegevenscontrole uit. AfterPay hanteert een strikt privacybeleid zoals omschreven in het privacy statement. Mocht onverhoopt jouw verzoek tot betaling met AfterPay niet geautoriseerd worden, dan kun je jouw bestelling natuurlijk betalen met een andere betaalmethode. Wil je meer informatie over achteraf betalen met AfterPay? Ga dan naar de website van AfterPay.
AfterPay – Achteraf betalen voor bedrijven
Bij [webshop url] kun je achteraf betalen met AfterPay als zakelijke klant. Wanneer je je bestelling afrondt via AfterPay ontvang je van hen een digitaal betaaloverzicht en betaal je het orderbedrag aan AfterPay. Ter goedkeuring van je verzoek om achteraf te betalen voert AfterPay een gegevenscontrole uit. AfterPay hanteert een strikt privacybeleid zoals omschreven in het privacy statement. Mocht onverhoopt jouw verzoek tot betaling met AfterPay niet geautoriseerd worden, dan kun je jouw bestelling natuurlijk betalen met een andere betaalmethode. Wil je meer informatie over achteraf betalen met AfterPay? Ga dan naar de website van AfterPay.
Request final check
Go-live steps
Did you receive the live credentials? Then follow below steps to finish the implementation.
1) Set the ‘Test mode’ to ‘No’
2) Fill in the production Merchant ID, Portfolio ID and Password
Note: Did you receive an API key instead of a Merchant ID, Portfolio ID and Password? Please configure the production API key instead!
3) For each payment method, place an order using emailaddress rejection@afterpay.nl
4) Done? Reply to our last e-mail! You can also call us on +31 (0) 20 – 7 230 230 (OPTION 2)
Update from an older version
Please note! This section is not part of the normal integration. You can use this part if you want to update from an older version of the AfterPay module.
We advise to execute the following steps:
Step 1: Enable the Magento maintenance modus
php bin/magento maintenance:enable
Step 2: Update the AfterPay module with composer to the latest available version and also update its depending libraries
composer update afterpay/afterpay-module
Step 3: Upgrade Magento to migrate any changes needed for the newest AfterPay module
php bin/magento setup:upgrade
Step 4: Compile the latest code
php bin/magento setup:di:compile
Step 5: Deploy the static content
php bin/magento setup:static-content:deploy
Step 6: Disable the Magento maintenance modus
php bin/magento maintenance:disable
Step 7: Clear the cache
php bin/magento cache:clean
Please note! It is important to test the new version before you use it for live transactions. If you have any questions, please contact us.
Compatibility
The AfterPay Magento 2 module is tested up until version 2.2.5 of Magento 2.
Module version 2.0 and up is up to the new standards with Magento 2, and therefore more stable and useful. But it has a dependency which requires a minimum of Magento version 2.2.4.
Merchants who use a version older than Magento 2.2.4 can use version 1.9.1 of the AfterPay module, but we advise to update their Magento environment to the latest version to be able to use also the latest AfterPay module.
The compatibility is tested with the following external plugins:
- Fooman Surcharge, version 3.0.1
- PostNL, version 1.3.4
- One Step Checkout, version 1.2.023