Amazon Pay

Installation

The installation of Shopware Markets is possible in several ways.
On the one hand, you can obtain and configure the extension directly during the installation of Shopware in the initial setup wizard.
On the other hand, you can also license the Shopware Markets extension directly in the Shopware Store at store.shopware.com. You can then download and install the extension under Extensions > My Extensions
It is important that you have previously logged in with your account in the Shopware Account tab. 
After the extension has been installed, you can activate it using the button to the left of the extension.

Amazon Pay

Amazon Pay is a checkout process from Amazon that enables millions of Amazon customers worldwide to log in to third-party websites using their Amazon login and pay easily with the payment and shipping information from their Amazon account.

With the Amazon Pay extension for Shopware 6 you can quickly and easily activate Amazon Pay on your website. All you need is an Amazon Pay merchant account. If you don't have a merchant account yet, you can start the registration here.

After creating the account, please follow the steps described under "Amazon Pay access information" to obtain the access data required to configure the extension.

Features

  • Express Checkout with Amazon Pay Button on the following pages/elements:

    • Cart

    • Registration

    • Product details page

    • Minicart/Sidebar (Offcanvas Cart)

  • Amazon Pay as payment method for the regular checkout

  • "Sign-in with Amazon": account creation and login using an Amazon account

  • Support for "Multicurrency payments"

  • PSD2 compliant

System prerequisites

Shopware

  • Version: Shopware 6.1.0 or hgher
  • Valid SSL-Certificate and HTTPS enabled
  • Valid Amazon Pay merchant account (see next section)

Amazon Pay Access Credentials

A valid Amazon Pay merchant account is required to receive the access data required for the configuration of the extension. If you do not have a merchant account yet, you can register a new account here:

  • Germany (EUR): https://pay.amazon.de/signup
  • United Kingdom (GBP): https://pay.amazon.co.uk/signup

After logging in to your Seller Central account, you can follow the steps described below.

Step 1 - Open Integration Central

Please log in to Seller Central, then use the drop down on top of the page to select Amazon Pay (Sandbox View). Then select „Integration“  >  „Integration Central“ in the menu on top.

Step 2 - Choose eCommerce solution provider

On the top of the page, perform the following selection:

  • Integration channel: Website or mobile (1)
  • Choose your eCommerce solution provider [..]: Shopware 6 (2)
  • Get Instructions (3)

Step 3 - Open "Create API keys" dialog

First, scroll down on the page to the section „API access“, then click the button Create keys. If this button is not available and showing "Add Store ID" instead, click this button first and follow the steps on the next page for creating a new application. When having finished the application setup, choose again „Integration“ > „Integration Central“ via the menu on top to return to the original page. The button Create keys should now be visible.

Step 4 - Create API keys

In the dialog window, provide a name to the key pair and click "Create keys". A file will be downloaded to your machine that contains the "Private Key", which is similar to a password. Like a password, it should be stored at a secure place and never be shared via an unsecure channel like email. The Private Key will be uploaded later on to the Shopware instance via an import dialog.

Step 5 - Note down access credentials

Please note down the access credentials required for configuring the extension:

  • Store ID
     
  • Merchant ID
     
  • Public Key ID

Step 6 - Create Buyer Test Account

For testing the checkout, a test account is required to login to Amazon in the sandbox environment. For creating this account, please choose Integration > Test Accounts via the menu on top, then click "Create a new test account" on the following page. Fill out the fields for name, email address and password, then select a delivery address that is typical for the countries that you are supporting with your shop (for instance an address in the UK, in Ireland and maybe in Germany). When ready, click Create Account to finish the buyer test account setup.

Installation

Installation using the Shopware Community Store

You can download and install the Amazon Pay extension in your administration under Extensions > My Extensions.
It is important that you have previously logged in to the Shopware Account tab with your account and licensed the extension in the store
After the extension has been installed, you can activate it via the button to the left of the extension.

Manual Installation

If you want to upload the extension manually, you have to follow these steps according to the documentation:

Download the extension in your Shopware account in the Merchant area, if it is already available in your Shopware account.

  1. In the backend, choose Extension >My Extensions

  2. Choose Upload Extension

  3. Select the ZIP file downloaded before and confirm

  4. Wait a moment until the installation is confirmed with Extension has been uploaded (may take a moment)

  5. After the successful upload, open the menu on the right for the new entry, click "Install" and wait for the "Success" prompt.

  6. On the same screen, activate the extension via the selector in the middle.
     

Configuration

The extension settings are configured in Shopware Admin via Settings > Extensions > Amazon Pay.

Please note that only HTTPS domains are supported by Amazon Pay.

The settings can be configured individually for each sales channel. If the settings are to apply to the entire shop, the option All sales channels must be selected under Sales channel. For a sales channel-specific configuration, please select the respective sales channel instead. In addition, here you can directly select the payment method in the selected sales channel as the default payment method.

With the buttons Export settings and Import settings you have the possibility to export or import the settings for the extension Amazon Pay. By clicking on Export settings the download of the file
"swag-amazon-pay.config.json" starts automatically. As soon as you click on Import settings, a new dialog will appear where you can upload a file.

The settings for the various sections of the expansion are described below.

Account

In this area the access data of the dealer account are stored. The required data can be retrieved via Seller Central, see "Amazon Pay access information" in this documentation.

  • Payment region: The payment or currency region in which the Amazon Pay merchant account was registered. For all Euro countries please select EUR (Euro Region) here. For merchant accounts registered in the United Kingdom, please select GBP (United Kingdom) here.
  • Merchant-ID: The merchant ID to be copied from the Amazon Pay account, also called merchant ID.
  • Store-ID: The store ID to be copied from the Amazon Pay account, also called client ID.
  • Public-Key-ID: The public key ID, created in the API access data section of the Amazon Pay account.
  • Private Key: The Private Key created in the API access data section of the Amazon Pay account. Please open the previously downloaded file in a text editor, copy it completely and paste it by clicking on the Enter private key Button.

After entering all data of the merchant account, please click on Save. Then you can check the validity of the access data by clicking on the button Test API access data.

General settings

In this section you configure the general settings of the extension.
 

  • Activate sandbox: Enables Amazon Pay sandbox mode, which is used to test the checkout.
  • IPN-Url: The URL of the IPN recipient with which the shopware instance receives payment events from Amazon Pay, e.g. when a refund has been successfully processed. This URL must be stored in the merchant account as shown below. To do this, please copy the URL, then follow the steps in Seller Central:
    • Settings (button in the top right corner of the page)
      > Select integration settings
    • Click Edit in the Instant notification settings area
    • Insert the URL (if a URL is already entered here, then use the second field)
  • Intended use: The customer sees the value entered here on his account statements.

Note: If you are configuring Amazon Pay on a live site, please switch from Amazon Pay (sandbox view) to Amazon Pay (production view) in the dropdown in Seller Central in the upper right-hand corner and repeat the previously described steps for depositing the IPN URL.

Display Options

Here you can find different options to show and hide and the look of "Amazon Pay" and "Sign-in with Amazon" in your Storefront. 

Note: If you have activated the option "Hide Amazon Pay Button globally", you can show the button again by using the following command in the browser console. This will make the button invisible to other users. In addition, the command must be sent again each time the page is reloaded.


for (let item of document.getElementsByClassName("swag-amazon-pay-wrapper")) { if(!item)
{continue;} item.hidden = false }


Payment status assignment

Configure here which payment status the extension should assign when a certain payment event occurs, e.g. payment collection.

Advanced

    The collection mode specifies when a payment is collected. Payments can be collected either immediately (recommended), when changing to a certain order status, or manually.

    • Collect payment immediately: The payment will be collected immediately if this option is selected.
    • Collect payment on order status change: If you select this option, you can choose the status that will trigger the payment.
    • Collect payment manually: If this option is activated, the payment is not collected until this is triggered manually.
     You also have the option here to exclude products or entire product groups from Amazon Pay. Excluded products or product groups can generally not be paid with the payment method Amazon Pay. How to create dynamic product groups for this function, you will learn here.

    Logging

    Here you can configure the logging of the extension and download log files. Select Enable extended logging here, so that the relevant log data is available for support in case of an error. Please send the log data on request of the support team.

    Go Live

    Step 1: Run sandbox tests

    Before going live, the Amazon Pay Checkout should be fully tested. For this purpose, the previously created test account is used to test the start of the Amazon Pay Checkout via the following pages:

    • Shopping cart
    • Registration
    • Product detail page
    • Minicart/sidebar (Offcanvas shopping cart)

    Amazon Pay can also be used via the regular checkout "Checkout" if "Amazon Pay" is selected as payment method here.

    Step 2: Disable sandbox mode and run live tests

    After the checkout has been successfully tested, the Amazon Pay Sandbox mode can be disabled. To do this, please deactivate the option Enable sandbox in the extension options. Then delete all caches for security reasons and test the checkout again. You can now use a real Amazon account for this. Following the test with your real Amazon account, you should also immediately make a refund in order to have tested this process as well.

    Administration

    In your Admin Dashboard under Orders > Overview you can click on the tab Amazon Pay (1) after clicking on the order details for orders placed with Amazon Pay.

    This tab shows you all relevant information about the payment or transaction with Amazon Pay.

    In the general area on the left side you can see the account information (name and email address) (2) of your Amazon customer.
    On the right side you will find the payment information (3) for the order. The uppermost amount (marked bold) shows you the total value of the order. The value shown in green is the amount that has already been collected - i.e. paid - from the total amount. The amount in red indicates the amount of refunds.

    You can use the button Refund (4) to make a (partial) refund. After clicking this button a window will open in which you can enter the desired amount and the reason for the refund. After confirmation, the refund will be displayed in the payment information area (3).

    The button Cancel (5) can only be clicked if the payment has not yet been made. This allows you to cancel the payment process.

    By clicking the button Charge (6) you have the possibility to collect the amount partially or completely.

    In the grey-shaded area (7) you will find information such as the Amazon reference number, status, billing address and delivery address. The Amazon reference number is the ID of the payment that was made. You can search for this ID in the Amazon Pay Merchant Account in Seller Central to see more details.
    The status display gives you information about the current status of the payment from Amazon.

    In the payment history section (8) you can see when transactions were made in the past. You can use the Object ID to view further details about the payment in the Amazon Pay Merchant Account. If no transactions are visible here, please check urgently if your IPN settings are configured correctly, see [General Settings > IPN URL].

    Troubleshooting Guide

    In our Amazon Pay Troubleshooting Guide you will find help on possible problems, which are usually caused by a faulty configuration of the extension or a damaged template.

    Support

    Your Shopware account will provide you with competent support for setting up your shop and for any problems that may arise. To create a ticket, follow the instructions in the support documentation.

    Was this article helpful?