Skip to main content

Amazon Pay

Integration only for Callisto online stores

This page only contains instructions for integrating Amazon Pay in Callisto online stores. For further information on using Amazon Pay in Ceres online stores, refer to the detailed information in the plugin description available in the plentyMarketplace.

Pay with Amazon is a comprehensive payment solution for online sellers. Offer Pay with Amazon and enable millions of Amazon customers to shop securely on your website without re-entering their delivery and payment information. Customers can complete purchases quickly without leaving your website. The advanced option for Payment with Amazon is special because it offers pure payment processing. This means that you only transfer the necessary amount due in order to process the payment. No details about the shopping cart or item data will be transferred (see Amazon).

1. Important notes

This chapter provides you with important information about integrating the payment provider in plentymarkets.

Amazon Pay and store design

Note that the following conditions must be met before integrating Amazon Pay successfully in plentymarkets:

  • Use of the standard design Callisto (Version 3.4 or higher)

  • Use of the individual order process

  • Safe handling of the plentymarkets CMS

  • Experience with integrating payment providers

Pay attention to the delivery periods

If you use this payment method, then make sure that you can process your orders in 30 days or less. Otherwise they will automatically be cancelled after 30 days. If you sell items that generally take longer to process and deliver, then get in contact with the customer support provided by Amazon Pay. The deadline can be extended in individual cases.

2. Payment process with Amazon Pay

After the customer has added an item to the shopping cart (template: ItemViewItemToBasketConfirmationOverlay) a button is displayed (template variable: $AmazonPaymentsAdvancedButton). By clicking this button, the customer will be forwarded directly to Amazon Pay. The customer then has to log into Amazon Pay. The customer will then go through the widgets confirming the delivery address and the payment method in your online store. The customer will then go through the rest of the order process as usual. The payment by Amazon Pay will not be triggered before the order has been completed.
Amazon Pay payments can also be started directly from the shopping cart, if the customer clicks on the corresponding button there. Furthermore, the customer can select Amazon Pay later when selecting the payment method during the checkout. In this case, the customer will be forwarded to the Amazon Pay page and continues with the same process as described above.

2.1. SSL certificate

Your online store needs to have an SSL certificate in order for you to be able to use Amazon Pay. Several elements of this payment method are also included in the CMS. This makes it necessary to publish the design after configurations or changes have been carried out.

3. Registering with Amazon Pay

You need to set up a separate account for Amazon for the Amazon Pay payment method. You cannot use the Amazon Seller Central account that you created in the System » Markets » Amazon » Settings menu for this payment method. For further information about how to register with Pay with Amazon, refer to the Amazon Pay Integration Guide.

Creating a seller account usually takes about 1 to 2 weeks. This estimate includes the time needed for information to be verified. During this time, you will receive emails from Amazon Pay containing further instructions. Make sure that these emails are forwarded to the correct employee and that they follow the instructions in the emails to avoid any unnecessary delays.

Entering the merchant URL and the integrator URL

You have to save the merchant URL and the integrator URL your-plentystore.co.uk/plenty/api/payment_notification.php?payment=apa in Amazon Pay. Replace your-plentystore.co.uk with the address of your online store. The address of your online store can be found under Host in the System » Settings » API » Data menu. The https:// protocol must be entered. Refer to the Amazon Pay registration manual for further information.

4. Setting up Amazon Pay in plentymarkets

Proceed as follows to set up the interface to Amazon Pay in plentymarkets.

Setting up the interface to Amazon Pay:

  1. Go to System » Orders » Payment » Methods.

  2. Place a check mark next to the setting Also show inactive.

  3. Open the folder International.

  4. Click on Amazon Pay.
    → The Settings tab will open.

  5. Click on the Interface tab.

  6. Expand the client.

  7. Carry out the settings as desired. Pay attention to the information given in Table 1.

  8. Save the settings.

Table 1. Setting up the interface to Amazon Pay
Setting Explanation

Seller ID

Enter the seller ID that you received from Amazon.

Market ID

Select a country.

MWS Access Key ID

Enter the MWS Access Key ID that you received from Amazon.

Secret Key

Enter the Secret Key that you received from Amazon.

Sandbox mode

Yes = Test mode is activated in order to test the payment method.
No = Test mode is deactivated. This means that the interface is active.

AddressWidget Width

Enter the amount of pixels in order to determine the width of the Amazon address widget. The Amazon address widget is displayed instead of a delivery address selection.

AddressWidget Height

Enter the amount of pixels in order to determine the height of the Amazon address widget. The Amazon address widget is displayed instead of a delivery address selection.

AddressWidget ReadOnly Width

Enter the amount of pixels in order to determine the width of the Amazon address widget in the order overview. The Amazon address widget in the order overview cannot be edited.

WalletWidget Width

Enter the amount of pixels in order to determine the width of the Amazon payment method widget. If Amazon Pay was selected, then this widget will be displayed instead of the payment methods during the checkout. The selected payment method will be displayed to the customer.

WalletWidget Height

Enter the amount of pixels in order to determine the height of the Amazon payment method widget.

WalletWidget ReadOnly Width

Enter the amount of pixels in order to determine the width of the Amazon payment method widget in the order overview. The selected payment method is displayed in this widget in the order overview and cannot be edited.

Availability

Select the availability.
1 - 10 = Only items available up to the selected availability can be paid with Amazon Pay.
Do not check = The availability of the items will not be checked.
Set the availability in the tab of a variation.
Important: Amazon Pay generally requires you to ship an item within a maximum of 30 days. Otherwise the payment will be cancelled.

One account per client (store)

You must have a separate Amazon Pay account for every client. Therefore, you will find a submenu for each client in the Interface tab. Enter the individual access data for each store.

5. Activating the payment method

Set up and activate the Amazon Pay payment method in the Settings tab of the payment method. In addition, check the settings for Permitted payment methods in the customer classes and for Blocked payment methods in the shipping profiles.

6. Displaying Amazon Pay in the online store

An option to the default display of Amazon Pay in the online store, the template functions Container_CheckoutAmazonPaymentsAdvancedAddressWidget() and Container_CheckoutAmazonPaymentsAdvancedPaymentWidget() can be used to display the address and payment widgets for Amazon Pay individually in the online store. In addition, you will find multiple examples for integrating the Pay with Amazon button at the desired position in the design.

No changes to the active design

Do not make changes to your active design. Before making changes to the design, make a backup copy so that you can restore the original state of the design.

6.1. Displaying the Amazon Pay widgets

Proceed as described below to display the address and payment widgets for Amazon Pay individually in the online store.

Displaying the Amazon Pay widgets in the order process:

  1. Go to Item » Categories.

  2. Open the design’s folder, e.g. the folder for Callisto Light 3.

  3. Open the category Payment & shipping.

  4. Click on the Description 1 tab.

  5. Insert the code example at a desired position.

  6. Save the settings.

Code example for the Amazon Pay widgets:

<div class="row equal margin-bottom-1" data-plenty="UI.equalHeight(this, 'lg, md, sm')">

	{% $_apaAddress = Container_CheckoutAmazonPaymentsAdvancedAddressWidget() %}
	{% $_apaPayment = Container_CheckoutAmazonPaymentsAdvancedPaymentWidget() %}


	<div class="col-lg-6 col-md-6 col-sm-6" data-plenty-checkout-template="MethodsOfPaymentList">
		{% if strlen($_apaPayment) > 0 %}
			$_apaPayment
		{% else %}
			{% Container_CheckoutMethodsOfPaymentList() %}
		{% endif %}
	</div>

	{% if strlen($_apaAddress) > 0 %}
		<div class="col-lg-6 col-md-6 col-sm-6" data-plenty-checkout-template="MethodsOfPaymentList">
			$_apaAddress
		</div>
	{% endif %}

	<div class="col-lg-6 col-md-6 col-sm-6 shipping-select" data-plenty-checkout-template="ShippingProfilesList">
		{% Container_CheckoutShippingProfilesList() %}
	</div>

</div>

<div class="text-right">
	<button class="btn btn-primary btn-lg btn-block-xs" id="goToOrderSummaryButton" data-plenty="click:Redirect.toCheckoutTab('next')">
		<span>Next</span><span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
	</button>
</div>

6.2. Editing ItemViewItemToBasketConfirmationOverlay

Proceed as described below to integrate the Pay with Amazon button at the desired position in the overlay for the shopping cart. The overlay will be displayed after the customer clicked on the Add to shopping cart button in the online store.

Editing ItemViewItemToBasketConfirmationOverlay:

  1. Go to CMS » Web design.

  2. Open the folder Layout » ItemView.

  3. Open the template ItemViewItemToBasketConfirmationOverlay.

  4. Insert the code example at a desired position.

  5. Save the settings.

Code example for integrating the Pay with Amazon button in the overlay:

<a class="pull-left" style="padding: 5px 10px">
	$AmazonPaymentsAdvancedButton
</a>

6.3. Editing ItemViewBasketPreviewList

Proceed as described below to integrate the Pay with Amazon button at the desired position in the shopping cart preview.

Editing ItemViewBasketPreviewList:

  1. Go to CMS » Web design.

  2. Open the folder Layout » ItemView.

  3. Open the template ItemViewBasketPreviewList.

  4. Insert the code example at a desired position.

  5. Save the settings.

Code example for integrating the Pay with Amazon button in the shopping cart preview:

<div class="pull-right" style="padding-bottom: 5px;">
	{% CheckoutAmazonPaymentsAdvancedButton() %}
</div>

6.4. Customising the Shopping cart category

Proceed as described below to integrate the Pay with Amazon button at the desired position in the shopping cart.

Customising the Shopping cart category:

  1. Go to Item » Categories.

  2. Open the design’s folder, e.g. the folder for Callisto Light 3.

  3. Open the category Shopping cart.

  4. Click on the Description 1 tab.

  5. Insert the code example at a desired position.

  6. Save the settings.

Code example for integrating the Pay with Amazon button in the shopping cart:

<div class="margin-top-1 text-right">
	{% CheckoutAmazonPaymentsAdvancedButton() %}
</div>

6.5. Customising the Log in category

Proceed as described below to integrate the Pay with Amazon button at the desired position in the registration.

Customising the Log in category:

  1. Go to Item » Categories.

  2. Open the design’s folder, e.g. the folder for Callisto Light 3.

  3. Open the category Log in.

  4. Click on the Description 1 tab.

  5. Insert the code example at a desired position.

  6. Save the settings.

Code example for integrating the Pay with Amazon button in the log in:

<div class="col-lg-6 col-md-6 col-sm-6">
	<h4>Not registered yet?</h4>
	<hr class="margin-bottom-15">
	<div class="row">
		<div class="col-lg-4 col-md-4 col-sm-4">
			<p>
				<a class="btn btn-primary btn-block" href="{% Link_CustomerRegistration() %}"><span class="glyphicon glyphicon-pencil"></span> Register</a>
			</p>
			<p>
				You will be able to check your orders and amend your personal details in the My Account area at any time.
			</p>
		</div>
		<div class="col-lg-4 col-md-4 col-sm-4">
			<p>
				<a class="btn btn-default btn-block" href="{% Link_Checkout(3) %}"><span class="glyphicon glyphicon-briefcase"></span> Order as a guest</a>
			</p>
			<p>
				As a guest, you will be able to place your order without registering. You will have to enter your personal details again if you place another order at a later date.
			</p>
		</div>
		<div class="col-lg-4 col-md-4 col-sm-4">
			<div style="padding-bottom: 19px;">{% CheckoutAmazonPaymentsAdvancedButton() %}</div>
			<p>
				Pay quickly and conveniently with Pay with Amazon.
			</p>
		</div>
	</div>
</div>

7. Automatically sending notifications

Automate communication with your customers using Amazon Pay as payment methods for their orders. The following chapters list the necessary event procedures to automatically send shipping confirmations, cancellations as well as for processing refunds and reporting rejected payments.

Sending order confirmations

In addition to the event procedures described below, you can also set up an event procedure that automatically sends order confirmations to customers via email. However, note that Amazon Pay only imports customers' email addresses into your plentymarkets system after payment has been effected. To avoid mistakes, we recommend to set up the event procedure so that the email is not sent when the order comes in, but when incoming payment has been booked.

7.1. Automatically sending shipping confirmations

Set up an event procedure to automatically send shipping confirmations to Amazon when the outgoing items are booked. Booking the outgoing items and sending the shipping confirmation should not take place within the same event procedure. Otherwise, shipping of items might be confirmed before the outgoing items have been booked. Therefore, set up a separate event procedure to book the outgoing items that at the same time changes the status to 7.1, for example. Use the same status as event for the event procedure to send the shipping confirmation. In doing so, only those orders will be taken into consideration that have this status. If you have not created the status yet, go to System » Orders » Order status to do so.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter name.

  4. Select the event listed in table 2.

  5. Save the settings.

  6. Pay attention to the explanations given in table 2 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 2. event procedure for automatically booking outgoing items
Setting Option Selection

Event

Order change: Outgoing items booked

Filter 1

Order > Payment method

Amazon Pay

Filter 2

Order > Order type

Order

Procedure

Order > Change status

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter name.

  4. Select the event listed in table 3.

  5. Save the settings.

  6. Pay attention to the explanations given in table 3 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 3. event procedure for automatically sending shipping confirmations to Amazon Pay
Setting Option Selection

Event

Order change: Status change

Select status from previous event procedure.

Filter 1

Order > Order type

Order

Filter 2

Order > Payment method

Amazon Pay

Procedure

Shipping > Send shipping confirmation to Amazon Pay

7.2. Automatically sending cancellations

Set up an event procedure to automatically inform Amazon of cancellations.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter name.

  4. Select the event listed in table 4.

  5. Save the settings.

  6. Pay attention to the explanations given in table 4 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 4. event procedure for automatically sending cancellations to Amazon Pay
Setting Option Selection

Event

Order change: Status change

Select status for cancelled orders.

Filter 1

Order > Order type

Order

Filter 2

Order > Payment method

Amazon Pay

Procedure

Payment methods > Send cancellations to Amazon Pay

7.3. Automatically sending refunds

Create an order status for returns from Amazon Pay. This status will indicate that the return was checked and the correct amount was refunded. Corresponding returns then have to be given this order status. Give this order status an appropriate name, e.g. Return checked. Save this order status for the event procedures described below.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter name.

  4. Select the event listed in table 5.

  5. Save the settings.

  6. Pay attention to the explanations given in table 5 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 5. event procedure for automatically sending refunds to Amazon Pay
Setting Option Selection

Event

Order change: Status change

Select the order status that you created for checked returns.

Filter 1

Order > Order type

Return

Filter 2

Order > Payment method

Amazon Pay

Procedure

Payment methods > Send refund to Amazon Pay

Alternatively, the refund can be created through the order. Create an order status for credit notes from Amazon Pay. This status will indicate that the credit note was checked and the correct amount was refunded. Corresponding credit notes then have to be given this order status. Give this order status an appropriate name, e.g. "credit note checked". Save this order status for the event procedures described below.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter name.

  4. Select the event listed in table 6.

  5. Save the settings.

  6. Pay attention to the explanations given in table 6 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 6. event procedure for automatically sending refunds to Amazon Pay
Setting Option Selection

Event

Order change: Status change

Select the status for the Credit note to Amazon Pay.

Filter

Order > Order type

Credit note

Procedure

Payment methods > Send refund to Amazon Pay

7.4. Automatically reporting rejected payments

Set up an event procedure to automatically inform your customers of rejected payments. In order to inform your customers by email of rejected Amazon payments and change the status of these payments, create an order status for rejected payments by Amazon Pay or use an existing order status.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter a name.

  4. Select the event listed in table 7.

  5. Save the settings.

  6. Pay attention to the explanations given in table 7 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 7. event procedure for automatically reporting rejected payments by Amazon Pay
Setting Option Selection

Event

Payment: Rejected

Filter 1

Order > Payment method

Amazon Pay

Filter 2

Order > Payment status

Rejected

Procedure 1

Customer > Send email

Select email template;
Select Customer

Procedure 2

Order > Change status

Select the order status, e.g. [3.2] In waiting position

To top