After July 2021, the 2.3.x release line no longer received quality updates or user guide updates. PHP 7.3 reached end of support in December 2021, and Adobe Commerce 2.3.x reached end of support in September 2022. We strongly recommend upgrading to Adobe Commerce 2.4.x to help maintain PCI compliance.

Setting Up Amazon Pay

This site contains archived merchant documentation for a version of Adobe Commerce and Magento Open Source that has reached end-of-support. The documentation available here is intended for historical reference only and is not maintained. The Adobe Commerce Merchant Documentation for current releases is published on the Adobe Experience League.

Amazon Pay and Login with Amazon work together to create a great buyer experience. For more information, see the Amazon Pay and Login with Amazon extension for Magento 2 documentation provided by Amazon.

Prerequisites

You must have the following resources available to complete the Amazon Pay setup in the Magento Admin:

Connect to Amazon Pay

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the upper-left corner, set the Scope to establish where the Amazon Pay configuration applies.

  3. In the left panel, expand Sales and choose Payment Methods.

  4. If needed, expand Expansion selector the Other Payment Methods section.

  5. For Amazon Pay, click Configure.

    Sales configuration - Amazon Pay Amazon Pay

  6. If you do not have your registered Amazon Pay account information, click Get started with account registration to register a new account through Amazon Seller Central.

    Do not use your personal Amazon account for Amazon Pay.

  7. When you have your account information, complete the following sections.

Credentials

Your credentials are transferred automatically from your Amazon Pay account to the Magento Admin. Your credentials can also be found in Amazon Seller Central in both Production and Sandbox modes.

Configure credentials for Sandbox mode

  1. Get your Test Credentials for the Amazon Pay Sandbox.

  2. Expand Expansion selector the Credentials section.

    Sales configuration - Amazon Pay credentials Amazon Pay credentials

  3. Select the Test Credentials checkbox.

  4. Use one of these methods for supplying the account credentials:

    • Enter the following credentials that you copied from Amazon Seller Central:

      • Merchant Id
      • Access Key Id
      • Secret Access Key
      • Client ID
      • Client Secret

    • For Credentials JSON, enter the JSON string of all Amazon Pay seller credentials.

      This JSON will be used to set values for Merchant Id, Access Key Id, Secret Access Key, Client Id, and Client Secret on save and clear any of the values that were entered manually.

  5. Set Sandbox to Yes.

  6. Set the Payment Region for the store.

  7. When complete, click Save Config to validate the supplied credentials.

    Look for the message, Your Amazon configuration is valid at the top of the Configuration page.

    If your credentials are valid, continue with the configuration. Otherwise, correct your credentials and try again.

Change credentials for Production mode

When you are through testing and ready to go live with Amazon Pay, return to the configuration and modify the settings:

  1. Clear the Test Credentials checkbox.
  2. Set Sandbox to No.
  3. Click Save Config.

Options

  1. Expand Expansion selector the Options section.

  2. Set Enable Amazon Pay to Yes.

  3. Set Enable Login with Amazon to Yes.

  4. Set Payment Action to one of the following:

    Charge on Shipment (Default) Amazon receives a capture request and charges the customer when an invoice is created in Magento.
    Charge on Order Amazon creates the invoice and charges the customer when the order is placed.

  5. Set Authorization Mode to determine the method that is used to transmit authorization data.

    Immediate (Default) Makes the disposition of an authorization available within a couple of seconds.
    Automatic (Recommended) Uses synchronous authorization, if possible, and switches to asynchronous processing as needed for some declines. The change in processing modes is transparent to the user. The status of sales order is Pending while the disposition of authorization is outstanding.

  6. Set Update Mechanism to one of the following:

    Data Polling via Cron job (Default) Uses the standard Magento notification process that is scheduled by Cron job.
    Instant Payment Notifications (IPN) Sends notifications to the Instant Payment Notification URL.

    Sales configuration - Amazon Pay options Amazon Pay options

Advanced

Frontend

  1. Expand Expansion selector the Frontend section.

  2. (Optional) If your store is available in multiple languages, you can display the text on the Amazon Pay button in a different language for each store view.

    To override the default display language for the current store view, enter one of the following language parameters for Button Display Language:

    • en-GB - English (Great Britain)
    • de-DE - German (Germany)
    • fr-FR - French (France)
    • it-IT - Italian (Italy)
    • sp-SP - Spanish (Spain)

    To learn more, see Language in the Amazon Pay Integration Guide.

  3. Set Button Color to one of the following:

    • Gold
    • Light Gray
    • Dark Gray

    To learn more, see the Merchant Tools page on the Amazon Pay website.

  4. Set Button Size to one of the following:

    • Small
    • Medium
    • Large
    • Extra Large

  5. Choose Yes for each feature that you want to enable for the current store view:

    • Show Login with Amazon in authentication popup
    • Show Amazon Pay button on product Page
    • Show Amazon Pay button in minicart
    • Show Amazon Pay in payment methods

    Frontend

Sales Options

  1. Expand Expansion selector the Sales Options section.

  2. Enter the Store Name.

    Sales configuration - Amazon Pay sales options Sales Options

  3. If you have a payment region in EU or UK, you may have an option for Use Multi-currency.

    Amazon Pay multi-currency feature is supported for the payment regions EU and UK.

    Amazon Pay multi-currency supports:

    • Australian Dollar (AUD)
    • British Pound (GBP)
    • Danish Krone (DKK)
    • Euro (EUR)
    • Hong Kong Dollar (HKD)
    • Japanese Yen (JPY)
    • New Zealand Dollar (NZD)
    • Norwegian Krone (NOK)
    • South African Rand (ZAR)
    • Swedish Krone (SEK)
    • Swiss Franc (CHF)
    • United States Dollar (USD)

    Sales configuration - Amazon Pay multi-currency Amazon Pay configuration - Sales Options with multi-currency

Developer Options

  1. Expand Expansion selector the Developer Options section.

  2. Make sure that Logging is set to Yes.

    After the setup is complete and logs are generated, you can return to this location and select a link in Developer Logs to download and view Client and IPN logs. If logs are not available or have not been generated, the No logs are currently available. message appears.

  3. To limit the availability of the Login with Amazon and Amazon Pay buttons, specify the Allowed IPs.

    Enter the IP address of each, separated by a comma. The specified IP addresses are added to an allow list. When this field is blank, the buttons are available for all IP addresses.

    Sales configuration - Amazon Pay developer options Amazon Pay configuration - Developer Options

Complete the configuration

  1. When all settings are complete, click Save Config.

  2. When prompted to update the cache, click Cache Management in the system message and follow the instructions to refresh the cache.

© 2024 Adobe. All rights reserved.