Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Amazon Pay Drop-in

Add Amazon Pay to an existing Drop-in integration.

Our Web Drop-in renders Amazon Pay in your payment form. When clicking the Amazon Pay button, the component redirects the shopper to an Amazon Pay hosted page where they select the details of the purchase before reviewing and confirming the order. This is supported from Web Drop-in 4.1.0.

Before you begin

This page explains how to add Amazon Pay to your existing Web Drop-in integration. The Web Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before starting your Amazon Pay integration:

  1. Make sure that you have set up your back end implementation, and added Drop-in to your payments form.
  2. Add Amazon Pay in your test Customer Area.

Register for Amazon Pay

Sign up for a merchant account on the Amazon Pay website. After the registration is complete, return to this page. Select the correct region for your account from the list below.

  • EU Registration — For merchants with a legal entity in one of the following countries: Austria, Belgium, Cyprus, Denmark, France, Germany, Hungary, Ireland, Italy, Luxembourg, the Netherlands, Portugal, Spain, Sweden, or Switzerland. Select EUR as a currency in the registration page.
  • UK Registration — For merchants with a legal entity in the United Kingdom.
  • US Registration - For merchants with a legal entity in the United States.

Create an Amazon Pay Sandbox test buyer account

Use Sandbox to conduct end-to-end tests of your integration before going live. For details, see Amazon Pay Sandbox accounts. After creating an Amazon Pay Sandbox account, return to this page.

Get your PublicKeyId and give information to Adyen

Amazon Pay uses asymmetric encryption to secure communication. Therefore, you need a public/private key pair.

To set this up, you must have one of the following user roles.

  • Merchant admin
  • Manage API Credentials
  1. Log in to your Customer Area and select the merchant account you want to set up Amazon Pay for.
  2. Select Developers > API credentials. Select the web service user that you will use for Amazon Pay transactions.
  3. In Wallet payment methods > Amazon Pay certificate, select + Add.
  4. Select Generate key pair.
  5. Copy the the public key and send it to your Amazon Pay contact.
  6. Receive the publicKeyId from your Amazon Pay contact.
  7. Send the following to our Support Team:
    • publicKeyId
    • amazonMerchantId: You can find this in your Amazon Seller Central or ask your Amazon Pay contact for it.
    • amazonStoreId: You can find this in your Amazon Seller Central or ask your Amazon Pay contact for it.
      We configure Amazon Pay for you after receiving your information.

Your Amazon publicKeyId is unique to a single web service user. You cannot use the same publicKeyId for multiple web service users.

Show Amazon Pay in your payment page

After you have finished configuring Amazon Pay, you can show the Amazon Pay button in your payment form:

  1. Make a /paymentMethods request with one of the supported combinations of countryCode and amount.currency.
  2. When creating an instance of Drop-in, make sure you're adding an amount object containing the currency and value of the payment, in minor units.

When the shopper clicks the Amazon Pay button, they are redirected to the Amazon website to log in and select the payment details.

Drop-in configuration

When creating an instance of Drop-in, you can also:

  • Configure the appearance of the Amazon Pay button.
  • Change productType.
  • Include additional data, such as address and merchant metadata.
Parameter Description Default
buttonColor Color of the Amazon Pay button. Supported values: Gold, LightGray, and DarkGray. Gold
deliverySpecifications Use the deliverySpecifications parameter to specify shipping restrictions for your shop, and prevent buyers from selecting unsupported addresses from their Amazon address book. See address restriction samples for examples of common use cases. Don't set this parameter if you are selling digital goods. In this case, set the productType parameter to PayOnly. {}
environment required Set to test. Change this to live when you're ready to accept live payments. test
locale Language used to render the button and text on Amazon Pay hosted pages. Please note that supported language(s) is dependent on the region that your Amazon Pay account was registered for. Supported values: en_GB, de_DE, fr_FR, it_IT, es_ES. en_GB
merchantId Amazon Pay merchant account identifier.
placement Placement of the Amazon Pay button on your website. Supported values: Home, Product, Cart, Checkout, Other. Cart
productType Product type selected for checkout. Supported values:
PayAndShip — Offer checkout using the shopper's Amazon wallet and address book. Select this product type if you sell physical goods that you ship to the address associated with the shopper's Amazon account.
PayOnly — Offer checkout using only the shopper's Amazon wallet. Select this product type if you do not need the shopper's shipping details, as you are selling digital goods.
PayAndShip
publicKeyId The publicKeyId from Step 3.
returnUrl required The URL where the shopper will be redirected back to after they complete the selection of details from the Amazon hosted page.
storeId Retrieve this value from Amazon Pay Integration Central.
chargePermissionType The type of charge permission requested. Supported values:
OneTime — for a single payment.
Recurring — for recurring payments.
OneTime
recurringMetadata How often the shopper will be charged using a recurring charge permission, for example monthly or yearly. Required for payments with chargePermissionType Recurring. Specify a frequency even if you expect ad hoc charges. See Amazon Pay documentation for more information.

Here's an example of the Amazon Pay Drop-in configuration for a payment of 30 USD once a month:

const dropin = checkout
    .create('dropin', {
        // ...
        paymentMethodsConfiguration: {
            amazonpay: { // Optional configuration for Amazon Pay
                productType: 'PayAndShip',
                merchantMetadata: {
                    merchantReferenceId: 'Merchant-order-123',
                    merchantStoreName: 'MyStore',
                    noteToBuyer: 'Thank you for your order'
                },
                chargePermissionType: 'Recurring', // For a recurring payment
                recurringMetadata: { // For a payment that happens once a month
                  frequency: {
                    unit: 'Month',
                    value: '1'
                  },
                  amount: {
                    amount: '30'
                    currencyCode: 'USD'
                  }
                },
                addressDetails: {
                    name: 'Simon Hopper',
                    addressLine1: 'Broadway 8-10',
                    city: 'London',
                    postalCode: 'SW1H 0BG',
                    countryCode: 'GB',
                    phoneNumber: '+44 203 936 4029'
                },
                environment: 'test',
                returnUrl: 'https://example.com/process_payment'
            }
        }
    })
    .mount('#dropin');

Handle the redirect

When the shopper confirms the payment, they are redirected back to the returnUrl with the amazonCheckoutSessionId attached to the URL. Use the amazonCheckoutSessionId to create an instance of the Amazon Pay Component to make the actual payment.

  1. Create a DOM element for the Component, placing it where you want it to be rendered. At this point of the flow, the Component doesn't show anything. This page executes the logic of the payment and handles any additional shopper interaction. The Component uses this node, for example, in case a 3D Secure 2 challenge needs to be displayed.

    <div id="amazonpay_payment-container"></div>
  2. Define a handleOnSubmit function to be passed to the Component configuration object as a value for the onSubmit parameter. The function should accept the state.data object from the Drop-in as an input, and trigger the backend function that you define, which executes the /payments API call.

    onSubmit: (state, component) => {
      component.setStatus('loading');
    
      // Merchant's function to make a payment
      return makePayment(state.data)
          .then(response => {
              component.setStatus('ready');
              if (response.action) {
                  // Handle additional action (3D Secure / redirect / other)
                  component.handleAction(response.action);
              } else {
                  // The merchant's function to show the final result or redirect to a final status page
                  handleFinalResult(response);
              }
          })
          .catch(error => {
              // Handle error;
          });
    }
  3. Create an instance of the Amazon Pay Component and pass amazonCheckoutSessionId. Hide the Order button by setting showOrderButton to false. After the Component is mounted, trigger the submit function which should be defined in the Adyen Checkout constructor.

    const amazonPayComponent = checkout
      .create('amazonpay', {
          amazonCheckoutSessionId: '...',
          showOrderButton: false
      })
      .mount('#amazonpay_payment-container');
    
    amazonPayOrder.submit();

    This will call the onSubmit event, which contains a state.data object. Pass the object to the server to make a payment and parse the result of the payment.

Make a payment

From your server, make a /payments request, specifying the following parameters:

  • paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
  • returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.
curl https://checkout-test.adyen.com/v68/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "amount": {
    "currency": "EUR",
    "value": 1000
  },
  "reference": "YOUR_ORDER_NUMBER",
  "paymentMethod": {
    "type": "amazonpay"
  },
  "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"

response = adyen.checkout.payments({
  :amount => {
    :currency => "EUR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "amazonpay"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
    Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
    Checkout checkout = new Checkout(client);

    PaymentsRequest paymentsRequest = new PaymentsRequest();

    String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
    paymentsRequest.setMerchantAccount(merchantAccount);

    Amount amount = new Amount();
    amount.setCurrency("EUR");
    amount.setValue(1000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setType("amazonpay");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");

    PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "EUR",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "amazonpay"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'EUR'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'amazonpay'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("EUR", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "amazonpay"
};
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "EUR", value: 1000 },
    paymentMethod: {
        type: 'amazonpay'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "adyencheckout://your.package.name"
}).then(res => res);

The /payments response contains:

  • pspReference: Adyen's unique reference for the payment.
  • resultCode: Authorised
/payments response
{
   "pspReference": "8815658961765250",
   "resultCode": "Authorised"
}

Amazon Pay works with cards the shopper has previously stored with Amazon. Because the card is tokenized, the payment is categorized as shopper initiated Card On File. Amazon Pay payments are displayed with shopper interaction ContAuth in the Customer Area payment page.

Handle the decline flow

In case of a credit card decline, due to card expiration or insufficient funds, you should redirect the shopper back to the Amazon Pay payment method selection page. You can do this by calling the handleDeclineFlow from the Amazon Pay Component.

This flow will allow you to handle authorization declines as described in the Amazon Pay documentation.

onSubmit: async (state, component) => {
    try {
        const response = await makePayment(state.data);
        // Check the result code
        if (response.resultCode && checkPaymentResponse(response.resultCode)) {
            // Show successful message
        } else {
            // Handle decline flow
            amazonPayComponent.handleDeclineFlow();
        }
    } catch (error) {
        // Fatal error
    }
},
onError: (error) => {
    if (error.resultCode) {
        // Show payment failed message or start over the flow.
    } else {
        // Fatal error
    }
}

Present the payment result

Use the resultCode that you received in the /payments response to present the payment result to your shopper.

The resultCode values you can receive for Amazon Pay are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
If you are using manual capture, you also need to capture the payment.
Cancelled The shopper cancelled the payment. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. For more information, check the refusalReason field. Inform the shopper that there was an error processing their payment.
Refused The payment was refused. For more information, check the refusalReason field. Redirect the shopper back to the payment page and ask them to try the payment again using a different card. For more information on how to do this, check Amazon Pay's documentation.
Additional resultCode values are possible in case of the 3D Secure authentication flow. For more information, refer to Result codes.

If the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for Amazon Pay are:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.
OFFER_CLOSED true The shopper did not complete the payment. Cancel the order and inform the shopper that the payment timed out.

Optional. Sign out from Amazon

After the transaction is finished, and the result is shown to the shopper, display a button to let them sign out from the Amazon account.

  1. Create a DOM element for the Sign out button, placing it where you want it to be rendered:

    <div id="amazonpay_signout"></div>
  2. Create an instance of the Amazon Pay Component and pass the amazonCheckoutSessionId along with showSignOutButton set to true.

    const amazonPayComponent = checkout
      .create('amazonpay', {
          amazonCheckoutSessionId: '...',
          showSignOutButton: true
      })
      .mount('#amazonpay_signout');

Recurring payments

We support recurring transactions for Amazon Pay. To make recurring payments, you need to:

  1. Create a shopper token.
  2. Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

  • storePaymentMethod: true
  • shopperReference: Your unique identifier for the shopper.

When the payment has been settled, you receive a webhook notification containing:

  • eventCode: RECURRING_CONTRACT
  • originalReference: The pspReference of the initial payment.
  • pspReference: This is the token that you need to make recurring payments for this shopper.
Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard notifications. You can enable the RECURRING_CONTRACT event code in the webhook settings page.

Make a payment with a token

To make a payment with the token, include in your /payments request:

  • paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT.
    You can also get this value by using the /listRecurringDetails endpoint.
  • shopperReference: The unique shopper identifier that you specified when creating the token.
  • shopperInteractionContAuth.
  • recurringProcessingModel: Subscription or UnscheduledCardOnFile.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Recurring transaction types.

curl https://checkout-test.adyen.com/v68/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
       "amount":{
          "value":1000,
          "currency":"EUR"
       },
       "paymentMethod":{
          "type":"amazonpay",
          "storedPaymentMethodId":"7219687191761347"
       },
       "reference":"YOUR_ORDER_NUMBER",
       "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
       "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       "shopperInteraction":"ContAuth",
       "recurringProcessingModel": "Subscription"
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "EUR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "amazonpay",
    :storedPaymentMethodId => "7219687191761347"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :shopperInteraction => "ContAuth",
  :recurringProcessingModel => "Subscription"
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

PaymentsRequest paymentsRequest = new PaymentsRequest();

String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
paymentsRequest.setMerchantAccount(merchantAccount);

Amount amount = new Amount();
amount.setCurrency("EUR");
amount.setValue(15000L);
paymentsRequest.setAmount(amount);

DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.setRecurringDetailReference("7219687191761347");
paymentMethodDetails.setType("amazonpay");
paymentsRequest.setPaymentMethod(paymentMethodDetails);

paymentsRequest.setReference("YOUR_ORDER_NUMBER");
paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
paymentsRequest.setShopperInteraction("ContAuth");
paymentsRequest.setRecurringProcessingModel("Subscription");

PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "EUR",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "amazonpay",
    "storedPaymentMethodId" => "7219687191761347"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  "recurringProcessingModel" => "Subscription",
  "shopperInteraction" => "ContAuth",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'EUR'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'amazonpay',
      'storedPaymentMethodId': '7219687191761347'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j'
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
   'shopperInteraction':'ContAuth',
   'recurringProcessingModel': 'Subscription'
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Model.Checkout.Amount("EUR", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "amazonpay",
  StoredPaymentMethodId = "7219687191761347"
};
var paymentsRequest = new Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  ShopperReference = "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  RecurringProcessingModel = "Subscription",
  ShopperInteraction = "ContAuth",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "EUR", value: 1000 },
    paymentMethod: {
        type: 'amazonpay',
        storedPaymentMethodId: "7219687191761347"
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
    shopperInteraction: "ContAuth",
    recurringProcessingModel: "Subscription"
}).then(res => res);

Test and go live

To test Amazon Pay, you must follow the Amazon Pay testing guidelines.
You can check the status of an Amazon Pay test payment in your Customer Area > Transactions > Payments.

Before you can accept live Amazon Pay payments, you need to submit a request for Amazon Pay in your live Customer Area.

See also