MenuPlease select your page
Shopware 6.3 payment plugin for AfterPay and Buy Now Pay Later
Shopware is a popular e-commerce platform. We have developed a module that easily integrates with a Shopware-based webshop. It is a simple way to let your customers start using AfterPay at checkout. You don't need advanced technical skills to add AfterPay to your Shopware webshop!
This guide describes the functionalities of the AfterPay module for Shopware and how to set up the plugin in your webshop.
We offer 3 different payment options:
- 14-day invoice - This is the default 14-day invoice payment method in AfterPay. It is always available in every market where AfterPay operates. It is primarily meant for business-to-consumer sales.
- Direct Debit - This is a Direct Debit version of the 14-day invoice payment method Instead of receiving an invoice to be paid via their bank, the customer enters their bank details, and the money is immediately deducted from their bank account.
- Instalments - This is a Part Payment invoice. The customer can split their purchase over multiple monthly fixed payments.
The payment methods that are available via this plugin can be found in this table:
|Country||14-day invoice||Direct Debit||Fixed instalments|
This document assumes that you already have a working webshop that uses Shopware (version 6 or above). If you don't, you can download the software and learn how to use it here.
What you need
- A Shopware instance, installed on your webserver.
- An API key.
- If you just want to try AfterPay without commitment, you can get one via the Developer Sandbox.
- Test Mode credentials will be provided by your Implementation Manager at AfterPay.
- When you are ready to go live, contact your Implementation Manager at AfterPay. They
will configure your webshop in the backend, and give you the real production API Key.
Basic settings can be accessed from the Shopware main menu as follows:
You can access the system settings via the shop settings. In the selection that appears, select the item "Plugins".
You will now see all the plug-ins that you use or have used in the shop. Now call up the Config of the AfterPay plugin.
1) Mode - This setting determines whether the plugin
runs in Test or Live mode.
2) Autocapture - If activated, the plugin will trigger an
automated capture via cronjob based on current order status.
3) Capture order / payment / delivery statuses - This defines the order / payment / delivery status which will trigger an automated capture.
4) Activate profile-tracking - Please only activate this when asked to do so by AfterPay.
5) Tracking ID - Enter the profile tracking ID assigned to you by your integration manager here.
6) Log - Defines the logging level. Log files will be stored in the plugin folder.
1) AfterPay Production API Key - X-Auth Key for live operation will be communicated by AfterPay.
2) AfterPay Partner Test API Key - X-Auth Key for test operation will be communicated by AfterPay.
3) AfterPay Public Sandbox API Key - X-Auth Key for the public sandbox. An API key for the public sandbox can be obtained from the following link.
4) AfterPay Merchant ID - Only fill in if communicated by AfterPay. Used to customize terms and conditions displayed during checkout.
Note, please ensure you add the API key in the correct country field!
Payment method settings
Payment method settings can be accessed from the Shopware main menu as follows:
Settings -> Shop -> Payment
Each country has its own payment methods. You don't need to enable and configure all of these - only the ones that you want to offer to your customers.
Available payment methods:
- 14-day invoice
- Direct Debit
For detailed definitions of the available payment methods please see the Introduction.
By clicking on the three dots, you can edit or delete the payment method.
In the “Payment method” section, you can set general settings for the payment method.
In the “Availability rule” section, you can set existing rules or create new rules.
The availability of payment methods defers per country because of local demand and legislation. The currently available payment methods per country can be seen in the Introduction chapter.
After completing the setup the next step is to test the connection.
Standard test scenarios
Please submit the following test scenarios. To check your own test transactions proceed to paragraph check test order. Complete the table with your order numbers and send it to your AfterPay Implementation Manager. You can put multiple test cases in one order but please refer to the right order number after each testcase.
|#||Test case||Order number|
|1.||Test an order with multiple products|
|2.||Test an order with a fixed discount|
|3.||Test an order with a percentual discount|
|4.||Test an order with a shipping fee|
|5.||Test an order with an alternate delivery address|
|6.||Test an order with pick-up points (if applicable)|
|7.||Test an order with store pick-up (if applicable)|
|8.||Test an order with a house number addition|
|9.||Test and make sure the VAT is correcly received by AfterPay|
|10.||Test an order with a payment fee if applicable (not recommended to be used)|
Payment method scenarios
After you tested all standard scenarios for the 14-day invoice you should start testing the other payment methods you activated. Please complete the tables with your order numbers and send them to your AfterPay Implementation Manager.
If you want to integrate Direct Debit please proceed with this test order:
|#||Test case||Order number|
|D-1.||Test an order with the Direct Debit payment method|
If you want to integrate Instalments please proceed with these test orders:
|#||Test case||Order number|
|I-1.||Test an order with 3 month instalments|
|I-2.||Test an order with 6 month instalments (if applicable)|
|I-3.||Test an order with 12 month instalments (if applicable)|
Customer facing messages
It is also necessary to check if the error messages are correctly shown to the customer.
- Test a rejected authorize. Please make sure that the customer friendly message is displayed correctly in the check-out.
- Test validation error. Please make sure that the customer friendly message is displayed correctly in the check-out.
Check test order
You are able to verify the transactions on the AfterPay side by yourself. You can do this with the "GET ORDER" call. You can send these calls for example with Postman. The response will show you how the transactions a registered on the AfterPay side. Documentation for the "GET ORDER" call can be found below.
Returns the contents of the specified order
In this chapter we will explain the AfterPay visual guidelines you need to apply to your webshop.
Logos and banners
For convenience and a familiar customer experience, please integrate/enclose the AfterPay logo in your Checkout next to the payment method. Please refer to our Merchant Playbook for full details on how to make the customer experience smooth and frictionless.
When Implementing the AfterPay logo throughout the shopping experience please ensure you are using our URL, not by downloading the image. The AfterPay logos are hosted on a Content Delivery Network (CDN) to ensure the best performance and availability for your website. Furthermore, you do not have to care about changes, which are all done by AfterPay.
We provide two types of logos through our CDN - .svg and .png. We recommend using the AfterPay logo as a .svg file with regard to the quality and size of the file. If you prefer .png just change the end of the URL to .png. We also offer the AfterPay logo in different color schemes. Depending on your individual website background, choose the AfterPay logo that fits best.
|AfterPay Checkout Logo in SVG, 4.3Kb||https://cdn.myafterpay.com/logo/AfterPay_logo_checkout.svg|
|AfterPay Black Logo in SVG, 5.44Kb||https://cdn.myafterpay.com/logo/AfterPay_logo_black.svg|
|AfterPay White Logo in SVG, 5.61Kb||https://cdn.myafterpay.com/logo/AfterPay_logo_white.svg|
Terms and conditions
In this chapter, we will explain which steps you need to take to enable the payment method on production.
Configure live mode
Once you and your Implementation Manager are satisfied with the validation of account setup and testing, you will get a Live Auth key and can start offering AfterPay to your customers!
Note, you will only get the Live Auth Key after you have signed the contract with AfterPay.
Congratulations! You just went live with your AfterPay connection. Please notify your AfterPay Implementation Manager that you went live. If you encounter any issues in the upcoming week you can contact your AfterPay Implementation Manager. After that period you can contact our local Merchant desk for help.
Introduction to the AfterPay Merchant Portal
You can go to the Merchant Portal here. Once logged in, you will also see an in-depth guide on how to make the most of your portal.
In the merchant portal you can:
- View and mutate your AfterPay orders
- Get financial reports
- Set up your branding in the AfterPay systems
Manage your orders
All orders placed are listed in the Shopware 6 backend under the menu tab "Orders". Here you
can get all the necessary information about the orders.
For each order, you can click on the 3 dots next to the respective order to display more detailed
information, delete the order and capture the order.
View details of an order
Under the "View" tab, you can get more information about a particular order and adjust its status.
In the "Details" section, you can see all the information about the order. In addition, the order statuses are displayed, which can be changed here.
In the "Status" section you can adjust the status of the order and see the old order statuses.
The plugin offers automatic as well as manual capture options:
Automatic capture can be configured in the plugin settings.
Manual capture will be triggered via the order overview.
After a successful capture, the capture icon will disappear.
The automatic capture can be set via the Basic Configurations, described in the second chapter of this guide.
The option Autocapture must be activated. This is done by checking the checkbox. The above indicated statuses must be defined. Orders with statuses that match the configured Autocapture statuses will automatically be captured. If the status of an order differs from the defined statuses, the order will not be captured. Please note that this only applies to orders that were received after the Autocapture feature was activated.
Changing the statuses is described in chapter 4. of this manual..
Scheduled tasks with cronjob
The AfterPay module for Shopware makes use of scheduled tasks to capture orders automatically. A 'capture' initiates the invoicing process towards the customer and should start after orders are being shipped. The scheduled task checks if orders are ready to be captured, and if so executes the capture request.
The scheduled task relies on the Shopware system and most probably are already configured on your Shopware environment because other modules make use of this as well. If not, or if you are not sure that this is done, it is best to take a look at the Shopware documentation. It describes how a scheduled task should be configured in your server environment.
If this is all configured, the AfterPay module will add an entry to the database table 'scheduledtask' identified as 'coloafterpay.capturepaymenttask', normally with the status 'scheduled' or 'queued'. If there is an issue with this scheduled task, then the status will be 'error'. And if so, you should look into the 'var/log' directory to see if there are any descriptions of the problem.