Please select your page


    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:


    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

    1. A Shopware instance, installed on your webserver.
    2. 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.

    You will also need to include the AfterPay logos and Terms & Conditions / Privacy Policy links in your webshop's design, especially the Checkout page.


    Basic configuration


    API settings

    MicrosoftTeams-image (54).png

    Payment method settings

    Payment settings.PNG
    payment methods.PNG

    Available payment methods:

    • 14-day invoice
    • Direct Debit
    • Instalments

    For detailed definitions of the available payment methods please see the Introduction.

    MicrosoftTeams-image (53).png

    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 correctly received by AfterPay

    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.

    GET /api/v3/orders/{orderNumber}

    Returns the contents of the specified order

    Visual guidelines

    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.

    DescriptionCopy URLLogo
    AfterPay Checkout Logo in SVG, 4.3Kbhttps://cdn.myafterpay.com/logo/AfterPay_logo_checkout.svgAfterPay Checkout Logo in SVG, 4.3Kb
    AfterPay Black Logo in SVG, 5.44Kbhttps://cdn.myafterpay.com/logo/AfterPay_logo_black.svgAfterPay Black Logo in SVG, 5.44Kb
    AfterPay White Logo in SVG, 5.61Kbhttps://cdn.myafterpay.com/logo/AfterPay_logo_white.svgAfterPay White Logo in SVG, 5.61Kb

    Terms and conditions

    AfterPay mandates that it is mandatory for a consumer to be presented with AfterPay's terms and conditions and Privacy Policy upon checkout. Thus the option to display the T&C should be always enabled in the plugin configuration. In certain cases where you would like to incorporate the AfterPay T&C and Privacy Policy within your own Terms and Conditions, this must be done only with approval from AfterPay's legal counsel. After approval include the country specific T&C and Privacy Policy resources.


    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.

    Last check (Only applicable for the BeNeLux)

    Now that AfterPay is live, we only have to check whether orders are also coming in properly.
    You can test this per AfterPay connection by placing a rejected order:

    STEP 1
    Go to the webshop, and place a product in the shopping cart.

    STEP 2
    Go to checkout and fill in the necessary information, for the email address you have to enter rejection@afterpay.nl.

    STEP 3
    Choose the payment method AfterPay and finish the order.

    The AfterPay order should be rejected. If this is not the case and instead you receive a technical error or an authorization error please contact your AfterPay Implementation Manager.


    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 best use it.

    In the merchant portal you can:

    • View and mutate your AfterPay orders
    • Get financial reports
    • Setup your branding in the AfterPay systems

    Manage your orders



    View details of an order

    MicrosoftTeams-image (55).png
    MicrosoftTeams-image (56).png


    Manual capture


    Auto capture

    The automatic capture can be set via the Basic Configurations, described in the second chapter of this guide.


    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.