Configuration

Get Amazon Pay ready for operation.

Basic Procedure

1. Connect to your Amazon merchant account and activate the module: Connecting to your Amazon merchant account.

2. Under Operation Mode, make sure Sandbox is selected for configuring and testing Checking the operating mode.
   The Sandbox operation mode is set by default after activation.

3. Under Payment Region and Delivery Region, check the configuration of your currencies and delivery countries: Checking currencies and countries.

4. Under Placement of Amazon Express, define where you want to display the Amazon Express button (for one-click payment): Placement: Displaying the Amazon Pay Express button.

5. Under Performance, ensure that you use Amazon Pay only for those products that are approved by Amazon: Performance: Ensuring compliance.

6. Under Amazon Social Login, check if you want to allow customers to log in to your OXID eShop with their Amazon account: Amazon Social Login: Configuring the Login.

7. Optional: If required, under Capture Type, configure payments to be triggered on a delayed basis (for business customers, for example): Capture Typ: Enabling reservation.

8. Link the AmazonPay payment method to your shipping methods, check the currency settings, and make test payments in the Amazon Sandbox: Optional: Ensuring correct currency settings.

9. If you use the AmazonPay Express payment method: Repeat step 8 for the AmazonPay Express payment method.

10. When you have completed your tests, under Operation Mode, switch to Production: Testing Amazon Pay and activating production mode.

11. If required: If you have particularly privacy-sensitive customers, implement a consent procedure, for example with Usercentrics.

    For more information, see Integrating Consent Management Platforms.

Connecting to your Amazon merchant account

Generating Amazon access data

To connect your OXID eShop to Amazon, generate the Amazon access data.

Prerequisites

You have created a merchant or developer account.

• If you already have an Amazon merchant account, you can create a sandbox account in it.

• If you are starting with a developer account, you can register your Amazon merchant account later.

For more information about registering a merchant account or a developer account, see Register for Amazon Pay (developer.amazon.com/de/docs/amazon-pay-checkout/get-set-up-for-integration.html#1-register-for-amazon-pay).

Procedure

1. Log on to Seller Central under sellercentral-europe.amazon.com.

2. Choose Integration ‣ Integration Central (Fig.: Choosing Integration Central).

   

   Fig.: Choosing Integration Central

3. In the Ecommerce provider or integration type list, choose Oxid CV2 (Fig.: Showing instructions for OXID, item 1).

4. Choose Show instructions (Fig.: Showing instructions for OXID, item 2).

   

   Fig.: Showing instructions for OXID

   
   Under Instructions for OXID, the See guide for Oxid (CV2) button appears (Fig.: Showing instructions for OXID, item 3), so your settings are correct.

5. Under Manage client ID/store ID(s) choose Create new client ID/store ID (Fig.: Create new client ID/store ID link, item 1).

   

   Fig.: Create new client ID/store ID link

6. To create a store ID, under Create a new Amazon Pay Client/Store ID configuration (Fig.: Creating a new Amazon Pay Client/Store ID configuration) enter the following data:

   • Application or store name: Enter a publicly visible name of your OXID eShop.
     Typically, enter your company name.

   • Description: Enter the store name you entered under Master Settings ‣ Core Settings.

   • Privacy policy URLs: Enter the URL of the privacy policy you created under Customer Info ‣ CMS Pages (for example, https://myshop.de/Datenschutz).

   

   Fig.: Creating a new Amazon Pay Client/Store ID configuration

7. Choose Save changes.

8. Navigate back to the Integration Central page.
   The Store ID and Merchant ID are displayed in the corresponding display fields (Fig.: Displaying store ID and merchant ID, items 1, 2).

   

   Fig.: Displaying store ID and merchant ID

9. Under Create API keys, choose the Create keys button (Fig.: Displaying store ID and merchant ID, item 3).
   The Create API keys dialog box appears (Fig.: Create API keys dialog box).

   

   Fig.: Create API keys dialog box

10. Ensure the Generate API credentials radio button is selected (Fig.: Create API keys dialog box, item 1).

11. In the Name your API keys field (Fig.: Create API keys dialog box, item 2), enter a name, Sandbox, for example.

    Letters and numbers are possible, but no special characters (spaces, for example).
    The API key name can help you distinguish API keys if you use more than one.
    Example: To have a better overview of payment transactions, create separate API keys for your different subshops.

    Tip

    If you use a developer account, make that clear in the API key name to avoid confusion.

12. Choose Create keys.
    A key pair is created and the private key is automatically downloaded in a PEM file (Fig.: PEM file in your download directory).

    

    Fig.: PEM file in your download directory

13. Save the PEM file.

Result

You have the data you will need to create the webhook:

• The downloaded PEM file containing the private key (Fig.: PEM file in your download directory)

• Displayed under API credentials:

  • Store ID (Fig.: Displaying the data to create the webhook, item 1)

  • Merchant ID (Fig.: Displaying the data to create the webhook, item 2)

• Displayed under Existing API keys: Public key ID (Fig.: Displaying the data to create the webhook, item 3)

  

  Fig.: Displaying the data to create the webhook

Activating Amazon Pay

Activate the Amazon Pay in each subshop where you want to use the module.

Procedure

1. Choose Extensions ‣ Modules.

2. Choose the Amazon Pay - Online-Payment module and choose Overview ‣ Activate.

Result

Under Shop Settings ‣ Payment Methods, the payment methods Amazon Pay and AmazonPay Express are marked as active.

Generating an Amazon Pay webhook

Generate a webhook in your OXID eShop using your Amazon access data.

Prerequisites

• You have generated the access data at Seller Central (see Generating Amazon access data).

Procedure

1. Choose Amazon Pay ‣ Configuration.

2. Before testing, under Operation Mode, ensure that you have set the Sandbox operation mode (Fig.: Entering the data to create the webhook, item 1).

3. Enter the access data in the following entry fields:

   • Entry field Private Key (Fig.: Entering the data to create the webhook, item 2): Key from the downloaded PEM file

     Note

     Be sure to enter prefix and suffix as well (-----BEGIN PRIVATE KEY-----, for example).

   • Entry field Public Key ID (Fig.: Entering the data to create the webhook, item 3): Public Key ID as displayed on the Amazon Integration central page (Fig.: Displaying the data to create the webhook, item 3)

   • Entry field Merchant ID (Fig.: Entering the data to create the webhook, item 4): Merchant ID as displayed on the Amazon Integration central page (Fig.: Displaying the data to create the webhook, item 2)

   • Entry field Store ID (Fig.: Entering the data to create the webhook, item 5): Store ID as displayed on the Amazon Integration central page (Fig.: Displaying the data to create the webhook, item 1)

   

   Fig.: Entering the data to create the webhook

4. Save your settings.

Result Your entries are checked, the module is active.
In the IPN Endpoint field, the webhook is displayed (Fig.: Displaying the IPN endpoint, item 1).

Fig.: Displaying the IPN endpoint

Registering the IPN endpoint with Amazon

Register the webhook of your OXID eShop in your Amazon merchant account or Amazon developer account.

Prerequisites

• You have generated a webhook (see Generating an Amazon Pay webhook).

• Under Amazon Pay ‣ Configuration, in the IPN Endpoint field, a URL is displayed.

Attention

Missing status messages

If you have tested the features of Amazon Pay on a dedicated test system, the URL displayed as the IPN endpoint is different from that of your production system.

In production mode, with the test system IPN endpoint, your OXID eShop would not receive notifications about the status of customer payments. You would need to manually check the status in Amazon Seller Central.

When you switch to production mode, ensure that you register the IPN endpoint of your production system.

Procedure

1. Under sellercentral-europe.amazon.com log in to Seller Central.

2. Choose Integration Settings (Fig.: Choosing Integration Settings).

   

   Fig.: Choosing Integration Settings

3. Under Instant Notification Settings, choose Edit (Fig.: Choosing Edit).

   

   Fig.: Choosing Edit

4. Paste the URL from the IPN Endpoint field into the Merchant URL field (Fig.: Registering the IPN endpoint, item 1).

5. Choose Update (Fig.: Registering the IPN endpoint, item 2).

   

   Fig.: Registering the IPN endpoint

Result

Your Amazon webhook is registered.

Note

To verify that receiving messages about the status of payment transactions works, make test payments.

For more information, see Testing Amazon Pay and activating production mode.

Checking the operating mode

Under Operatiion Mode, make sure that for configuring and testing Sandbox is selected. (Fig.: Verifying the sandbox operating mode, item 1).

Fig.: Verifying the sandbox operating mode

Checking currencies and countries

Check which currencies and shipping countries your customers have to choose from when you offer Amazon Pay to your customers.

Verifying the payment region

If necessary, adjust the configuration of your currencies or your payment methods.

Background

In the configuration step below, Optional: Ensuring correct currency settings, you will make sure that the currencies your OXID eShop supports match the currencies that Amazon Pay supports.

Under payment range, the result is displayed (Fig.: Checking supported currencies and countries, item 1). These are the currencies that simultaneously supported by Amazon Pay and that you configured in the basic settings of your Oxid eShop.

Fig.: Checking supported currencies and countries

Attention

Conversion at risk.

Example: You have configured Hungarian Forint as allowed currency in your OXID eShop.

Amazon Pay does not support Hungarian Forint. Therefore, if your customer selects Forint as the currency, the Amazon Pay button will not be displayed.

If there is no alternative payment method to pay, your customer bounces.

Adjust the configuration of your currencies or your payment methods.

Procedure

If your Oxid eShop supports currencies that Amazon Pay does not support, you have the following options:

• Under Shop Settings ‣ Payment Methods, make sure you offer the necessary alternative payment methods in addition to AmazonPay and AmazonPay Express.
  For example, to allow your foreign customers to pay in local currency, you could offer pay upon invoice.

• Under Master Settings ‣ Core Settings ‣ Settings ‣ Other settings, remove the currencies that are not supported by Amazon Pay.
  Customers in Hungary, for example, would have to pay in euros with Amazon Pay.

Verifying the delivery region

Check if Amazon Pay supports the countries you are willing to ship to.

Provide alternative payment methods if needed.

Attention

Conversion at risk.

Under Master Settings ‣ Countries, you have configured to which countries your Oxid eShop should deliver.

Under Delivery Region, you can see which countries you have configured as possible delivery countries in your Oxid eShop and which are supported by Amazon Pay at the same time (see Supported countries, Fig.: Checking supported currencies and countries, item 2).

This means that of the delivery addresses that your customer has stored with Amazon, only those that are in the countries displayed under Delivery Region will be offered to your customer for selection when paying with Amazon Pay.

So it may happen that the Amazon Pay button is displayed, but the customer cannot choose a delivery address.

To be able to pay with Amazon Pay, your customer would have to specifically enter a different shipping address in Amazon. The conversion is at risk.

Therefore, if you want to serve customers whose shipping addresses are in countries that are not supported by Amazon Pay, provide alternative payment methods.

Procedure

If you want your Oxid eShop to support delivery countries that are not supported by Amazon Pay, do the following:

1. Choose Shop Settings ‣ Payment Methods.

2. Make sure you offer alternative payment methods besides AmazonPay and AmazonPay Express, for example, pay upon invoice.

3. Save your settings.

Configuring Amazon Pay

Configure Amazon Pay.

Placement: Displaying the Amazon Pay Express button

Specify where you want the Amazon Pay Express button to appear.

You don’t need to worry about the checkout page. There, the Amazon Pay button is always available for your customers to choose from.

Background

Technically, there are two Amazon Pay payment methods (Fig.: Amazon Pay payment methods).

Fig.: Amazon Pay payment methods).

Fig.: Amazon Pay payment methods

Accordingly, there are two Amazon Pay buttons:

• Amazon Pay Express makes buying convenient for your customers: The button allows a customer with an Amazon account to buy an item directly from the product detail page (Fig.: Amazon Express button on the product detail page, item 1) or from the shopping cart (Fig.: Amazon Express button in the shopping cart and in the shopping cart preview, item 1, 2).

  If necessary, you can hide these buttons.

  Example

  • Your customers typically have only one item in their shopping cart when they place an order?
    In this case, it makes sense to guide customers to their destination as quickly and barrier-free as possible and display the Amazon Pay Express button.

  • Do you generate a significant portion of sales or margin from accessory items?
    In this case, it may make sense to delay payment and offer the Amazon Pay Express buttons only in the shopping cart and checkout, for example.

  So you determine,

  • whether customers have to go through your checkout process and register in your eShop

    or

  • whether customers can trigger the order directly without registering with their Amazon account (quick purchase).

  

  Fig.: Amazon Express button on the product detail page

  

  Fig.: Amazon Express button in the shopping cart and in the shopping cart preview

• Amazon Pay (Fig.: Amazon Pay button in the checkout, item 1): This payment method is always available to the customer along with the other payment methods.

  If you hide the Amazon Express button or your customer chooses not to pay with their Amazon account, then this payment method is offered in the checkout.

  

  Fig.: Amazon Pay button in the checkout

Procedure

1. Do the following:

   • If you want the Amazon Express button to appear on the product detail pages, make sure the Product Detail Page checkbox (Fig.: Configuring the Amazon Pay Express button, item 1) is selected.

   • If you want the Amazon Express button to appear in the shopping cart as well as in the shopping cart preview, make sure that the Basket + Basket-Modal (Fig.: Configuring the Amazon Pay Express button, item 2) checkbox is checked.

   

   Fig.: Configuring the Amazon Pay Express button

2. Save your settings.

Performance: Ensuring compliance

Make sure your customers don’t pay for products with Amazon Pay that are subject to certain restrictions.

Prohibited content will cause Amazon to suspend your Amazon merchant account.

By default, Amazon assumes that your products are not subject to restrictions.

---

Background

Amazon checks whether the products you sell meet safety and compliance requirements or are subject to restriction.

In Germany, for example, restrictions apply to cigarettes, weapons, or products that glorify National Socialism.

If customers were to buy such products from your eShop and pay with Amazon Pay, these products would appear in the Amazon customers’ order history.

Because of the possible violation of compliance rules, this could result in legal difficulties for Amazon, for which you could be held jointly liable.

Therefore, check if any of your products are subject to such restrictions and exclude these products from payment with Amazon Pay.

---

Note

Performance degradation

If you exclude individual products from payment with Amazon Pay, your OXID eShop will perform a database query on every page load.

This will delay the loading of all pages of your OXID eShop by a few milliseconds.

Procedure

1. If you feel that some of your products might belong to the prohibited products or content category, check Amazon’s Acceptable Use Policy.
   If some of your products are indeed not in compliance with Amazon’s policies, proceed to step 2.

2. To be able to exclude products or categories from paying with Amazon Pay, under Performance, check the Exclude Amazon Pay checkbox.

3. Save your settings.

4. Under Administer Products ‣ Products or Administer Products ‣ Categories, choose the item or category you want to exclude from Amazon Pay.
   On the Main tab, you will find the Exclude Amazon Pay checkbox for this purpose.

5. Choose Exclude Amazon Pay checkbox.
   Ensure that other payment methods are assigned to the product or category.

6. Save your settings.

Result

The Amazon Pay and Amazon Pay Express buttons are not displayed for the product or category, and your customers must choose another payment method.

Amazon Social Login: Configuring the Login

Enable your customers to log in to your OXID eShop with an Amazon account.

The option is enabled by default. This makes the Sign in with Amazon button appear in two places in your OXID eShop:

• In the second step of the order process (Fig.: Sign in with Amazon button, item 1).

• In the Log in dialog box (Fig.: Sign in with Amazon button, item 2).

Fig.: Sign in with Amazon button

Disable logging in with Amazon if necessary.

Advantage of signing up with Amazon: You make the sign-up process more convenient for your customers.

Your customers will skip the login mechanism. Your customers log in to your OXID eShop without having to enter their password.

Procedure

To disable the login with Amazon, check the Deactivate Amazon Social Login checkbox.

Capture Typ: Enabling reservation

Specify whether payments should be collected immediately for the eShop, or whether payments should only be reserved.

Example

Typically, the money is collected immediately.

In certain cases, it makes sense that the payment is only triggered by the delivery:

• You sell certain individualized products that you do not manufacture, commission or order until the order is received.

• You have an eShop for business customers. Here, the delivery quantities and payment amounts are larger than for private customers.
  In the event of an error, returns management would be correspondingly more difficult.
  Therefore, you want to make sure that the payment is only triggered when the goods are there or on their way to be shipped.

Procedure

1. Under Capture-Type, you have the following options:

   • To trigger payments directly, choose One Step.

   • To reserve the payment only and trigger it later, choose Two Step.

2. Ensure that you have assigned only Amazon Pay to the customized products in your eShop.
   The delayed payment for payment by Amazon Pay takes effect for all items in your eShop to which you have assigned this payment method.

3. Save your settings.

Result

If you have selected the value Two Step for payment by Amazon Pay, the payment will be triggered,

• automatically: as soon as you have set the ordered item to the status Delivered in your eShop

• manually: when you confirm the payment in your Seller Central merchant account under Orders ‣ Manage Transactions

Optional: Ensuring correct currency settings

Ensure that the currencies your OXID eShop supports match the currencies Amazon Pay supports.

However, you can’t go wrong: For currencies that Amazon Pay does not support, only the Amazon Pay and the Amazon Pay Express buttons will not be displayed.

Amazon Pay supports the following currencies:

• AUD

• GBP

• DKK

• EUR

• HKD

• JPY

• NZD

• NOK

• ZAR

• SEK

• CHF

• USD

Prerequisites

• You have checked the currencies and countries configured (see Checking currencies and countries).

Procedure

1. Choose Master Settings ‣ Core Settings.

2. On the Settings tab, expand the Other settings area.

3. In the input field for currencies, check whether you want to add or remove currencies (Fig.: Configuring allowed currencies, item 1).

4. To ensure a clean configuration, for the AmazonPay payment types, on the countries tab, make sure that only those countries are assigned which have the currencies supported by Amazon Pay.

5. Repeat step 4 for the AmazonPay Express payment method.

Result

Under payment range (Fig.: Verifying allowed currencies, item 1) those currencies are displayed which are supported by your eShop and by Amazon Pay at the same time (see Verifying the payment region).

Fig.: Configuring allowed currencies

Fig.: Verifying allowed currencies

Optional: Refunding amounts for canceled or deleted orders manually

When you cancel or delete an order, by default, the payment amount is refunded to your customer automatically.

If needed, you can specify to refund payment amounts manually.

Example: You handle the order process, including refunds, in your ERP system. In this case, you disable automatic refunding in the module so that refunding does not happen twice.

For more information about canceling or deleting orders, see Canceling an order.

Procedure

Under Amazon automatic refund and cancel, choose one or both of the following options:

• To manually refund payment amounts for cancelled orders, deactivate the Activate Amazon automatic refund (order and order position storno) checkbox.

• To manually refund payment amounts for deleted orders, deactivate the Enable Amazon automatic cancel (order deletion) check box.

Testing Amazon Pay and activating production mode

Test Amazon Pay in the Amazon Pay Sandbox and adjust the configuration until all payment processes work the way you want.

To do this, run test payments in the Amazon Pay sandbox.

Recommendation: Use a dedicated test system for testing.

When the test payments work as desired, switch to production mode.

Prerequisites

• If you have tested Amazon Pay with your sandbox account on your production system, you have upgraded your sandbox account to an Amazon merchant account.
  To do so, in your Amazon Sandbox account, under Integration ‣ Integration Central, you have chosen the finish your account registration link and completed the registration.

• If you have tested on a test system and are now putting Amazon Pay into operation on the production system, with your Amazon merchant account you have generated the following access data:

  • The downloaded PEM file containing the private key

  • In Amazon Integration Central displayed under API credentials:

    • Store ID

    • Merchant ID

  • In Amazon Integration Central displayed under Existing API keys: Public key ID

  For more information, see Generating Amazon access data.

Procedure

Attention

Missing status messages

If you have tested the features of Amazon Pay on a dedicated test system, the URL displayed as the IPN endpoint is different from that of your production system.

In production mode, with the test system IPN endpoint, your OXID eShop would not receive notifications about the status of customer payments. You would need to manually check the status in Amazon Seller Central.

When you switch to production mode, ensure that you register the IPN endpoint of your production system.

1. Configure the module and test it.

2. Under Operation Mode, switch to Production.

3. If you have tested on a test system and are now putting Amazon Pay into operation on the production system, enter your Amazon merchant account access data.
   To do so, repeat the steps in chapter Generating an Amazon Pay webhook.
   If you have generated your sandbox from an existing merchant account or retroactively registered the merchant account, you do not need to re-enter the access data.

4. If you have tested on a test system and are now putting Amazon Pay into operation on the production system, register the IPN endpoint of your production OXID eShop.
   To do this, repeat the steps in chapter Registering the IPN endpoint with Amazon.
   If you have tested Amazon Pay with your sandbox account on your production system, you do not need to register the IPN endpoint again.
   Nevertheless, ensure in any case that the IPN endpoint of your production system is registered with Amazon.

5. Save your settings.

Result

Your production system receives status messages from Amazon about your customers’ payment transactions.