Configuration

Get Amazon Pay ready for operation.

Basic Procedure

  1. Connect to your Amazon merchant account and activate the module.
  2. Under Operation Mode, make sure Sandbox is selected for configuring and testing.
    The Sandbox operation mode is set by default after activation.
  3. Under Placement, specify where you want to display the Amazon Pay button.
  4. Under Performance, ensure that you use Amazon Pay only for those products that are approved by Amazon.
  5. Optional: If required, under Capture Type, configure payments to be triggered on a delayed basis (for business customers, for example).
  6. Link Amazon Pay to your shipping methods and shipping cost rules, and run test payments in the Amazon Sandbox.
  7. When you have completed your tests, under Operation Mode, switch to Production.

Connecting to your Amazon merchant acount

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).

    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).

    Showing instructions for OXID

    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).

    Create new client ID/store ID link

    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).
    Creating a new Amazon Pay Client/Store ID configuration

    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).

    Displaying store ID and merchant ID

    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).

    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).

    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:

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 is marked as active.

Generating an Amazon Pay webhook

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

Prerequisites

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:

    Entering the data to create the webhook

    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).

Displaying the IPN endpoint

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

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).

    Choosing Integration Settings

    Fig.: Choosing Integration Settings

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

    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).

    Registering the IPN endpoint

    Fig.: Registering the IPN endpoint

Result

Your Amazon webhook is registered.

Note

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

Configuring Amazon Pay

Configure Amazon Pay.

Placement: Displaying the Amazon Pay button

Specify where you want the Amazon Pay 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.

Procedure

  1. Do the following:
    • If you want the Amazon Pay button to appear on product detail pages, choose the Product Detail Page checkbox.
    • If you want the Amazon Pay button to appear in the shopping cart as well as in the shopping cart preview, choose the Minicart + Modal checkbox.
  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 button is not displayed for the product or category, and your customers must choose another payment method.

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 button will not be displayed.

Amazon Pay supports the following currencies:

  • AUD
  • GBP
  • DKK
  • EUR
  • HKD
  • JPY
  • NZD
  • NOK
  • ZAR
  • SEK
  • CHF
  • USD

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.
  4. To ensure a clean configuration, for the Amazon Pay payment method, on the Countries tab, ensure that only those countries are assigned that have the currencies supported by Amazon Pay.

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.