Pay with Amazon Magento extension Documentation · 2019-04-02 · Pay with Amazon Magento extension...

Pay with Amazon Magento extensionDocumentation

Release 1.3.4

Marek Zabrowarny

April 01, 2015

Contents

1 Overview 31.1 Extension features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Getting the extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3 Changelog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.4 Extension vendor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2 Prerequisites 72.1 System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.2 Amazon Advanced Payments APIs account setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 Installation 193.1 Pre-installation steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193.2 Installation process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193.3 Post-installation steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

4 Configuration 214.1 Amazon Payments Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214.2 General Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224.3 Login with Amazon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244.4 Email Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244.5 Common Appearance Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254.6 Appearance Settings for Login and Pay with Amazon . . . . . . . . . . . . . . . . . . . . . . . . . . 254.7 Appearance Settings for standalone Pay with Amazon . . . . . . . . . . . . . . . . . . . . . . . . . 264.8 Developer options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

5 Design customization 275.1 Frontend templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275.2 Amazon Payments logo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285.3 Email templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

6 Order & payment workflow 316.1 Pay with Amazon button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316.2 Placing an order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326.3 Payment authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336.4 Capturing the payment amount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346.5 Refunding order items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366.6 Cancelling an order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386.7 Synchronizing order data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

i

7 Testing your integration 417.1 How to create Sandbox test account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

8 Frequently Asked Questions 438.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438.2 Frontend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

9 Troubleshooting 459.1 Event logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459.2 Contact support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

ii

Pay with Amazon Magento extension Documentation, Release 1.3.4

Proudly provided by:

Contents 1


2 Contents

CHAPTER 1

Overview

This extension provides an official integration of your Magento store with Login and Pay with Amazon services.They help your customers shop quickly, safely and securely. Your customers can pay on your website without re-entering their payment and address details. All Amazon transactions are protected by Amazon’s A-to-z Guarantee.

The extension is a pure payment solution. No item level is communicated to Amazon Payments and it allows you tomanage your orders directly from Magento.

1.1 Extension features

• Pay with Amazon button in the shopping cart and in the 1st step of OnePage checkout

• Login with Amazon button on the customer login page

• Customization of Login and Pay with Amazon widgets from within Magento admin

• Support for payment authorizations, captures and refunds (also partial refunds)

• Supports Amazon Instant Payment Notifications

• Live & sandbox modes available

• Toolbox for simulating payment states in sandbox mode

• CSV-based event logger

1.2 Getting the extension

The extension can be installed via Magento Connect using following key:http://connect20.magentocommerce.com/community/Creativestyle_AmazonPayments.

Refer to the Installation section to get more details concerning installation procedure.

3

http://www.magentocommerce.com/magento-connect/login-and-pay-with-amazon-advanced-payment-apis-for-europe.html


1.3 Changelog

1.3.1 Version 1.3.4

Improvements

• Added gift messages support

• Improved customer address handling for Germany and Austria (extracting company name from the address)

Changes

• Switched IPN endpoint URL to non-secure mode if sandbox is enabled

Fixes

• Fixed missing original_price and base_original_price item’s attributes after order is placed

• Fixed state of Place order button which was enabled even the payment method is not selected

• Fixed state of Place order button which was disabled for virtual orders

1.3.2 Version 1.3.2

Major Highlights

• Implemented asynchronous way of loading Amazon Payments JS libraries

Improvements

• Added cURL error handling for Login with Amazon API calls

Changes

• Using deminified JS when sandbox mode is on for easier debugging

• Modified Pay with Amazon button tooltip text for virtual orders

• Refactored Amazon Payments SDK library to fix autoloader issues

Fixes

• Fixed wrong shipping cost when additional fees (acting as additional items in total section) are applied

• Fixed issue with Merge JS option enabled

• Closing OrderReference transaction after succesful capture

4 Chapter 1. Overview


1.3.3 Version 1.2.6

Major Highlights

• Implemented responsive Amazon Payments widgets in the checkout

Fixes

• Fixed error when accessing extension settings page on Magento lower than 1.7.0.1

• Fixed issues with Magento compiler

1.3.4 Version 1.2.4

Fixes

• Fixed Pay with Amazon button appearing twice when Login with Amazon feature is enabled

1.3.5 Version 1.2.2

Major Highlights

• Added Login with Amazon service

Improvements

• Added helper methods for generating Pay or Login with Amazon buttons

Changes

• Changed frontend template files structure

• Changed Pay with Amazon button in the 1st step of OPC to Login with Amazon

Fixes

• Clean orderReferenceId session data after successful order

• Fixed issue with permanently disabled Place order button when there is more than one layer with buttons-setclass used

• Fixed using of invalid Amazon account credentials when cancelling an order in non-default store of multi-storeinstallations

1.3. Changelog 5


1.4 Extension vendor

This extension has been developed by creativestyle GmbH in cooperation with Amazon Payments Europe S.C.A.

Creativestyle is an interactive agency with years of experience and origins in Germany. Our company is present in thee-commerce market since 2001. We focus on development and implementation of various Internet projects.

creativestyle GmbHGanghoferstr. 68 a80339 MünchenGermany+49 89 5480 7604http://www.creativestyle.de

6 Chapter 1. Overview

http://www.creativestyle.de

CHAPTER 2

Prerequisites

2.1 System requirements

Login and Pay with Amazon Magento extension requires you to have a valid Amazon Advanced Payments APIsaccount (refer to the Amazon Advanced Payments APIs account setup if you don’t have one yet) and a webserverrunning a Magento store instance with following conditions met:

• Magento CE (1.5, 1.6, 1.7, 1.8, 1.9) or EE (1.11, 1.12, 1.13, 1.14)

• cURL for PHP

• DOM / XML for PHP

• valid SSL certificate (for Login with Amazon and / or IPN handling)

Note: An additional fix needs to be installed for Magento 1.5. Please refer to the FAQ to get more details.

2.2 Amazon Advanced Payments APIs account setup

2.2.1 Registering an Amazon Payments Account

• Go to:

– DE merchants: https://payments.amazon.de/business/pre-registration-api

– UK merchants: https://payments.amazon.co.uk/business/pre-registration-api

• Click Business and choose Setup options → Advanced Payment APIs

7

https://payments.amazon.de/business/pre-registration-api?ld=SPEXDEAPAMagento

https://payments.amazon.co.uk/business/pre-registration-api?ld=SPEXUKAPAMagento


• Click Sign up

• Go through the questionnaire to find out if you qualify for using Amazon Payments, then click Sign up now

• At the moment you cannot add your Advanced Payments APIs account to an existing Amazon merchant account.You have to register a new account specifically for the Advanced Payments APIs.

• Start registering a new account:

– If you see the link Would you like to create a new account using a different e-mail address? Click here,please do so.

– Enter a name for your business. In case this name is already taken, please choose a different one.

– Enter an email address and a password. You should choose a role email address that will be read directlyby the people responsible for the Amazon Payments integration. You should avoid general addresses likeinfo@ that are only forwarded to the general administration.

– Choose a secure password.

8 Chapter 2. Prerequisites


• Please fill in all requested information about your seller account, your contact information and your bank accountor credit card data.

• Please be careful to provide exact and correct data. All information you provide will be verified by AmazonPayments, and incorrect information will delay the verification process.

2.2. Amazon Advanced Payments APIs account setup 9


• After providing all information there will be an identity check on the phone, where you will be asked to enter aPIN.

• Afterwards you can complete your registration

• After your account is registered you will be forwarded to your Seller Central account.

• Please be aware that you cannot fully use your account yet. First you have to provide your identity data, andthen the account has to go through the verification process.

2.2.2 Entering identity data in Seller Central

To get the verification process started, please log in to Seller Central: https://sellercentral-europe.amazon.com/gp/homepage.html

For a combined account (Advanced Payments APIs added to an existing account), please make sure that you haveselected the Amazon Payments – Production View in the drop down menu on the top.

At Settings → Account Info please provide the requested missing information. Especially it is crucial to provide theID information for all relevant persons.


https://sellercentral-europe.amazon.com/gp/homepage.html

https://sellercentral-europe.amazon.com/gp/homepage.html


2.2.3 Verification Process / Verification of all given information by Amazon Pay-ments

After successful registration of the Amazon Payments seller account and entering the ID information Amazon Pay-ments will check all information provided. Depending on the information provided Amazon Payments may requestmore information.

2.2.4 Creating MWS access keys

You can generate your MWS access keys in Seller Central. Please go to Integration → MWS Access Key



Log in again with your Amazon Payments account credentials

Make sure that you register the MWS Access Key for your own account.



Please read and accept the license agreement.

The AWS Access Key and the Secret Key among with the Merchant ID, will be presented to you on the next page.You can always review the key information in Seller Central on the Integration → MWS Access Key page.



2.2.5 Registering application for Login with Amazon service

Login and Pay with Amazon work together to provide a great buyer experience. To use Login with Amazon you haveto register the application (Magento extension) that will be allowed to access buyers accounts through your AmazonPayments seller account. Login with Amazon configuration settings can be accessed through Login with AmazonSeller Central page.

In the App Console register a new application by clicking the Register new Application button. The Register YourApplication form will appear.



In the application details page, add basic details about your web site. These details will be used on your website andmobile apps (if applicable).

• Name Shown to Users. This is the name displayed on the consent screen when the users agree to share theinformation with your web site. This name applies to Android, iOS, and website versions of your application.

• Description. A description of your web site for Login with Amazon users.

• Privacy Notice URL. The Privacy URL is the location of your company privacy policy. It is also displayedon the consent screen. This link is displayed to users when they first login to your application (for example:http://www.example.com/privacy.html).

• Logo Image File. This logo will represent your business or website on Amazon. The logo will be displayed asa 150x150 pixel image; if you upload a file of a different size, it will be scaled to fit.

When you are finished, click Save to save your changes.

Add a Website to your Application

• From the Application screen, click Web Settings. You will automatically be assigned values for Client ID, whichidentifies your website.

• To add Allowed JavaScript Origins to your application, click Edit.

An origin is the combination of protocol, your Magento shop domain name and port (for example:https://www.example.com:8443). Allowed origins must use the HTTPS protocol. If you are using a default port(443) you need only include the domain name of your shop (for example: https://www.example.com).

Adding your domain here allows the SDK for JavaScript to communicate with your Magento shop directly during thelogin process. Web browsers normally block cross-origin communication between scripts unless the script specificallyallows it.



To add more than one origin (in case you are running domain based multi-store Magento installation and all stores areusing the same Amazon Payments seller account), click Add Another.

Note: To use Login with Amazon with your Magento shop, you MUST specify an allowed JavaScript origin.

2.2.6 Where to find the required credentials to configure the Magento extension

The Magento extension requires you to enter information about your Amazon Payments account. You will need toenter:

• Merchant ID (aka Merchant Number, Händlernummer, Händler-ID)

Note: The Merchant Token IS NOT Merchant ID.

• AWS Access Key (aka AWS Access Key ID, AWS-Zugangsschlüssel, AWS Zugangsschlüssel-ID)

• Secret Key (aka AWS Secret Key, geheimer Schlüssel)

You can find this information in your Amazon Payments seller account in Seller Central.

Merchant ID

You can find the Merchant ID in Seller Central at Settings → Integration Settings



AWS Access Key / Secret Key

You can find the AWS Access Key and the Secret Key in Seller Central at Integration → MWS Access Key

Client ID

You can find the Client ID of your application in Seller Central at Login with Amazon → App Console by clicking WebSettings from the Application screen.



2.2.7 Configuration required in Seller Central

If you’re planning to use IPN for the post-payment processing you need to enter a Merchant URL (IPN endpoint URL)in Seller Central. You can do this at Settings → Integration Settings, then click the Edit button at Instant NotificationSettings. IPN endpoint URL can be obtained from Magento admin at System → Configuration → Amazon Payments,see: IPN endpoint URL.


CHAPTER 3

Installation

Warning: Be aware that after installing Login and Pay with Amazon extension your cart page will be auto-matically switched into SSL mode. It is always advised to test the extension in some staging environment prior todeploy to the production, especially in case you expect any issues caused by enabling SSL on the cart page.

3.1 Pre-installation steps

• Create a backup of your shop before proceeding to install.

• If your shop is using compilation (you can check it in System → Tools → Compilation), disable it please beforeproceeding to install.

3.2 Installation process

• Go to System → Magento Connect → Magento Connect Manager and enter your admin credentials to get loggedin.

• In the Install New Extensions section enter Login and Pay with Amazon extension key obtained from MagentoConnect and click Install button.

• Installation will start and after successful install it will show a message. Optionally, you can click on Refreshbutton to see if Login and Pay with Amazon (identified as Creativestyle_AmazonPayments) is listed on list ofthe installed extensions.

• Proceed to the post-installation steps.

3.3 Post-installation steps

• If you’re using custom design theme, refer to the Templates customization section to find out how to adjustLogin and Pay with Amazon templates to your needs.

• Go to System → Cache Management and flush Magento cache storage.

• If you have disabled compiler in pre-installation stage, you can go now to System → Tools → Compilation,recompile and enable compiler again.

• Logout from the Magento admin and login again.

19




Voila! The Login and Pay with Amazon extension shall be installed now. You can proceed to the Configurationfollowed by Frontend templates and Email templates customization (if applicable).

20 Chapter 3. Installation

CHAPTER 4

Configuration

After the successful installation you can proceed to the configuration. In the Magento admin go to System → Config-uration → Amazon Payments tab.

Available options are grouped within the following tabs:

4.1 Amazon Payments Account

In this section you can define your Amazon Payments seller account credentials.

21


4.1.1 Merchant ID, Access Key ID, Secret Access Key

Fill out those fields with your Amazon Payments seller credentials. You can find them in the Amazon Seller Central,see: Merchant ID and AWS Access Key / Secret Key.

4.1.2 Marketplace

Select the country where you registered your seller account from the provided drop-down list. If you’re unsure aboutthis information consult your Amazon Integration Assistant.

4.1.3 Validate Amazon Payments account

This button is designed to validate your Amazon Payments account credentials. Please use it to check whether yourcredentials (Merchant ID, Access Key ID, Secret Access Key and Marketplace) are valid or not.

4.2 General Settings

In this section you can enable or disable the Pay with Amazon service and define basic settings of the extension.

22 Chapter 4. Configuration


4.2.1 Enable Pay with Amazon

By switching this option you can enable or disable Pay with Amazon. This option must be set to “Yes” if you wantto provide the Pay with Amazon service to your customers.

4.2.2 Sandbox mode

Sandbox mode has been designed to test the Pay with Amazon service. In sandbox mode the selected paymentmethod is not charged. Refer to the Pay with Amazon documentation to get more information about the sandboxenvironment. In general, sandbox mode should be enabled for development and staging environments for testing andalways has to be disabled for production environments. Never show the sandbox buttons and widgets to buyers in yourlive environment.

4.2.3 Show Sandbox Toolbox

In sandbox mode you can simulate certain states for the different objects in the payment process. By enabling this op-tion you get additional fields on the Amazon Checkout page that allow selecting expected payment statuses for orders,authorizations, captures and refunds returned in responses. This feature allows you to simulate different scenariosincluding declines in the sandbox environment.

4.2.4 Payment Action

You can select the desired payment action taken after an order is placed. By default the authorization is made auto-matically at order placement and the capture must be triggered by the seller by creating an invoice in Magento admin(Authorize method). By selecting the Authorize & capture method, the order amount will be captured immediately atorder placement, which means that the authorization will be followed by an immediate capture call. If you want to usethis setting, it is mandatory that you get white-listed for this feature by Amazon Payments first. Do not activate thisoption without contacting Amazon Payments first.

Warning: Please use Authorize & capture method only in the case you are shipping goods on the same day theyare ordered and you have been white-listed for this service.

4.2.5 Enable Instant Payment Notifications

This option enables or disables handling of Instant Payment Notifications, which are used by Amazon Payments forsending feedback concerning the status of payment objects. Keep in mind that using IPN requires having a valid SSL(issued by a trusted CA) installed on your server and correctly configured Secure Base URL (System → Configuration→ Web). In case you disable IPN and want to use data polling instead you need to setup a cron for your shop.

4.2.6 IPN endpoint URL

This auto-generated value shall be entered in the Merchant URL field of the Integration Settings in your AmazonSeller Central in case you plan to use IPN. If you use more than one store view in your Magento installation, the IPNendpoint URL will be shown after selecting appropriate store view scope.

4.2. General Settings 23


4.2.7 Data polling frequency

If you don’t have a valid SSL certificate in your shop or due to any other reason you don’t want to use IPN, you canset how often status of the different object shall be polled from Amazon Payments servers. Note that the cron must besetup for your shop for periodic triggering routines that poll payment data.

4.2.8 Order status on authorization

With this option you can change the status to which an order will be set after a successful authorization. In most casesleaving the default value seems to be a good idea.

4.3 Login with Amazon

In this section you can configure Login with Amazon service.

4.3.1 Enable Login with Amazon

By switching this option you can enable or disable Login with Amazon feature. This service must be enabled if youwant to create customer accounts in your Magento shop when order is placed and to make sure that any of the orderspaid with Pay with Amazon will be never a guest order.

4.3.2 Client ID

The Client ID identifies your website for Login with Amazon service. Please refer to the Obtaining Client ID sectionto find out how to get the value of your Client ID.

4.4 Email Options

4.4.1 Send order confirmation

This option allows you to select whether a confirmation email for newly placed orders shall be sent by the shop. Notethat, regardless this setting, a payment confirmation will be always sent by Amazon Payments.



4.4.2 Declined Payment Email Template

In this option you can select an email template which will be used for notifying customers about declined authoriza-tions. Refer to the Email templates section to find out how to customize email templates.

4.4.3 Declined Payment Email Sender

With this option you can define the sender of the Authorization declined email notification. The sender can be selectedfrom the pre-defined Magento email contacts (System → Configuration → Store Email Addresses).

4.5 Common Appearance Settings

In this section you can set size (width and height) of the Amazon widgets used in the checkout process.

4.6 Appearance Settings for Login and Pay with Amazon

These settings apply to the design (type, size and color) of the buttons, both Pay with Amazon and Login with Amazon,when Enable Login with Amazon option is set to “Yes”, therefore they become irrelevant if you don’t use Login withAmazon service, you may be interested then in Appearance Settings for standalone Pay with Amazon.

4.5. Common Appearance Settings 25


4.7 Appearance Settings for standalone Pay with Amazon

These settings apply to the design (size and color) of the Pay with Amazon button when Enable Login with Amazonoption is is set to “No”, therefore they become irrelevant if you use Login with Amazon service, Appearance Settingsfor Login and Pay with Amazon are applied then.

4.8 Developer options

4.8.1 Allowed IPs (comma separated)

For testing or debugging purposes you can restrict access to Pay with Amazon checkout in your shop to certain IPnumbers only. Pay with Amazon button will be shown only for the visitors coming from allowed IPs. You can setmore than one allowed IP separated with commas.

4.8.2 Enable logging

The Pay with Amazon extension comes with a dedicated logging mechanism. Any exception, API call or IPN notifi-cation will be saved to the var/log/amazonpayments folder in your Magento installation. For your convenience logsare also accessible via creativestyle → Amazon Payments → Log preview in Magento admin. Refer to the Event logssection to get more details concerning the logging feature.


CHAPTER 5

Design customization

5.1 Frontend templates

If you are using a custom design theme and would like to adjust the appearance of Login and Pay with Amazontemplates, please complete the following steps (all paths are relative to the Magento root folder):

Warning: Never edit the default template or skin files directly as they can be (and surely will be) overwrittenwhen upgrading this extension to a newer version. Edit their copies only as described below.

• Create folders:

app/design/frontend/YOURPACKAGE/YOURTHEME/template/creativestyle/amazonpaymentsskin/frontend/YOURPACKAGE/YOURTHEME/creativestyle/cssskin/frontend/YOURPACKAGE/YOURTHEME/creativestyle/images

On Unix-like (Linux, BSD) servers you can achieve this by running following commands, please remember toreplace YOURPACKAGE and YOURTHEME with the real names of your theme:

$ cd /path/to/your/Magento$ mkdir -p app/design/frontend/YOURPACKAGE/YOURTHEME/template/creativestyle/amazonpayments$ mkdir -p skin/frontend/YOURPACKAGE/YOURTHEME/creativestyle/css$ mkdir -p skin/frontend/YOURPACKAGE/YOURTHEME/creativestyle/images

• Clone the following files:

app/design/frontend/base/default/layout/amazonpayments.xmlapp/design/frontend/base/default/template/creativestyle/amazonpayments/*skin/frontend/base/default/creativestyle/css/amazonpayments.cssskin/frontend/base/default/creativestyle/images/*

On Unix-like (Linux, BSD) servers you can achieve this by running following commands, please remember toreplace YOURPACKAGE and YOURTHEME with the real names of your theme:

$ cd /path/to/your/Magento$ cp app/design/frontend/base/default/layout/amazonpayments.xml app/design/frontend/YOURPACKAGE/YOURTHEME/layout/amazonpayments.xml$ cp app/design/frontend/base/default/template/creativestyle/amazonpayments/* app/design/frontend/YOURPACKAGE/YOURTHEME/template/creativestyle/amazonpayments/*$ cp skin/frontend/base/default/creativestyle/css/amazonpayments.css skin/frontend/YOURPACKAGE/YOURTHEME/creativestyle/css/amazonpayments.css$ cp skin/frontend/base/default/creativestyle/images/* skin/frontend/YOURPACKAGE/YOURTHEME/creativestyle/images/*

After cloning the above files to your theme folders, you can adjust the design by editing the appropriate files (HTMLtemplates, CSS stylesheets and layout file). You can enable Template Path Hints to find out the names of the templatefiles used by the extension in particular steps of the checkout process (in Magento admin, within selected store viewscope: System → Configuration → Developer → Debug).

27


Note: Please note that the ID attributes of all HTML tags must be preserved, otherwise changes to the correspondingJS scripts must be applied (do not try to change it unless you know what are you doing).

Basic appearance of rendered Amazon widgets (button color and size of all widgets) can be set in the Pay withAmazon extension settings (System → Configuration → Amazon Payments), see Common Appearance Settings, Ap-pearance Settings for Login and Pay with Amazon and Appearance Settings for standalone Pay with Amazon for moredetails.

5.2 Amazon Payments logo

If you want to place the Amazon Payments logo in your shop to let your customers know you’re using payment servicesprovided by Amazon Payments refer to the following guidelines:

• logos:

– UK: https://payments.amazon.co.uk/business/material#payment-marks-graphics

– DE: https://payments.amazon.de/business/material#payment-marks-graphics

• button placement:

– UK: https://payments.amazon.co.uk/business/material#button-guidelines

– DE: https://payments.amazon.de/business/material#button-guidelines

To complement the logos you should mention Amazon Payments under your listing of supported payment methods.

28 Chapter 5. Design customization

https://payments.amazon.co.uk/business/material#payment-marks-graphics

https://payments.amazon.de/business/material#payment-marks-graphics

https://payments.amazon.co.uk/business/material#button-guidelines

https://payments.amazon.de/business/material#button-guidelines


5.3 Email templates

Magento provides an easy-to-use mechanism for adjusting email templates’ appearance and content. If you want tocustomize the emails that are sent by the extension, go to System → Transactional Emails in your Magento admin andfollow the instructions:

On the Transactional Emails list press Add New Template button and the form will appear. In the Load default templatesection choose Amazon authorization declined from the Template dropdown, change Locale, if needed, which will beused for the loaded template pattern (Pay with Amazon extension provides 3 locales: German, English UK andEnglish US, for any other locale selected, the english (US) template will be loaded) and press Load Template button.

5.3. Email templates 29


Fields in Template Information section will be filled out with the data taken from the default email template. Pleasefill in the missing name of your modified email template in the Template Name input, adjust Template Content andTemplate Styles to your needs and save your work by pressing Save Template button. The new template shall appearon the Transactional Emails list.

The newly created email template can be used now, you can switch to it in the extension settings, see: DeclinedPayment Email Template.

30 Chapter 5. Design customization

CHAPTER 6

Order & payment workflow

The Login and Pay with Amazon extension follows the standard Magento order and payment workflow, and thusprocessing Pay with Amazon payments doesn’t differ significantly from other payment methods available in Magento,making it easy to handle. The most important difference, comparing to the standard Magento orders, is delayed accessto the billing address, which is backfilled later in the synchronization process after the successful authorization.

All Amazon payment objects (OrderReference, Authorize, Capture and Refund) are reflected in corresponding pay-ment transactions in Magento, which are connected with appropriate document entities provided by the Magento,(invoices for captures, credit memos for refunds).

6.1 Pay with Amazon button

The Pay with Amazon button appears in several places in the shop:

• on the shopping cart page,

• in the 1st step of the default One Page Checkout,

• in the sidebar cart widget.

You can also place the Pay with Amazon button in any place you like by including following statement in the templatefile:

<?php echo Mage::helper(’amazonpayments’)->getPayWithAmazonButton(); ?>

Pressing the Pay with Amazon button launches the Amazon Payments authentication window, where the customer isasked for his Amazon account e-mail address and password. After a successful login the customer is redirected to theAmazon checkout page in your shop.

31


6.2 Placing an order

The Pay with Amazon checkout form consists of 4 steps arranged within a single page (unlike Magento defaultcheckout, which uses accordion for showing and hiding particular steps of the checkout). These steps are: shippingaddress (handled by Amazon’s address book widget), payment method (handled by Amazon’s wallet widget), shippingmethod and order review (handled by default Magento checkout templates). All fields in the form (shipping address,payment method and shipping method) are pre-filled, which means that in very basic scenario customer can finish thecheckout with just one click. Unfortunately, pre-filling doesn’t apply to the terms and conditions checkbox (if used atall) and can raise the number of required clicks, which, however, doesn’t affect the easiness and user-friendliness ofthe Pay with Amazon payment method.

Note: The value selected in each checkout step is saved in a separate AJAX call. When the checkout form shows upfor the first time, depending on the internet connection speed and the web-server’s response time, it may take up tofew seconds until Place order button will be active and can be clicked by the customer.

After selecting the desired shipping address, payment method, shipping method and pressing Place order button(preceded by accepting terms and conditions if needed), the customer is redirected to the success page. Pay withAmazon uses the default Magento success page, which means there’s no need to add any tracking scripts or additional

32 Chapter 6. Order & payment workflow


page layout elements that you use in default Magento checkout and want also use in Amazon checkout, all featuresimplemented additionally on the Magento success page shall also appear on Amazon checkout success page.

The created order will be transferred to Amazon and will appear in your Magento admin in Pending state.

Note: You may notice in the Magento admin that the billing address may be incorrect at this point (as mentioned inthe introduction to this chapter). That’s true if the billing differs from the shipping data. The only available paymentobject at the time of placing order is the OrderReference, which, unfortunately, doesn’t provide billing data and thusshipping address must be used to meet Magento requirements concerning order data. The billing address will beupdated as soon as authorization is confirmed by Amazon Payments. Keep also in mind that the billing address isavailable only for the sellers that provided a valid VAT number in Amazon Seller Central.

6.3 Payment authorization

An authorization can be requested after the order data is successfully transferred to Amazon. Depending on thevalue you’ve selected for Payment Action option it can be processed in several ways. For Authorize and Authorize &capture actions it will be requested automatically as soon as order is placed in your shop and successfully transferredto Amazon. The requested authorization will be therefore either confirmed or declined by Amazon either via IPNmessage or via data polling, see Synchronizing order data to get more details. The order, for which a paymentauthorization has been confirmed changes its state to Processing, an order email confirmation is sent to the customer(if not disabled in the extension settings, see Send order confirmation) and you can start the fulfilment process.

Warning: Never dispatch ordered items before the authorization is confirmed. Only the confirmed authorizationguarantees that you will be able to capture the order amount (if you capture within 7 days).

6.3.1 Manual authorization

In case you ship ordered items after 30 days or more you have to select Manual authorization as a payment action. Itwill stop Magento from requesting an authorization automatically and let you make an authorization request manuallyfrom the Magento admin at any suitable time. To manually invoke an authorization, login to the Magento admin, openthe order you want authorize payment for and click the Authorize payment button placed in the top buttons rows.

6.3. Payment authorization 33


Next post-request processing (authorization confirmation or decline) is processed in the same way as in automaticauthorization (through polling or IPN).

6.3.2 Declined authorizations

If the authorization is declined by Amazon due to problem with the payment method selected, your customer willbe informed about this case via e-mail and requested to visit the Amazon Payments web site. The customer can onthis page update the payment method by following the instructions on the web page. The e-mail sent to the customercan be adjusted according to the Email templates section. After the successful payment method update, Amazon willnotify Magento about the new authorization status and payment will get back on the track (via polling or IPN).

In case the authorization has been declined due to any other reason then problems with the selected payment method,the notification email will be sent to shop administrator and appropriate action must be undertaken according to theAmazon Payments Integration Guide.

6.4 Capturing the payment amount

After a successful authorization, you can capture funds against the authorization. The capture, similar to the autho-rization, can be requested in two modes: manual and automatic. By default you should capture the order amount atthe moment you ship the ordered items by creating an invoice. You are only allowed to enable automatic captureif you sell digital goods or you ship items the same day they are ordered. Moreover you have to be white-listed byAmazon Payments. Contact Amazon Payments if you want to use this option.

Payment Action option in the extension settings allows to switch between manual and automatic capture mode. ForManual authorization & Authorization actions the capture is triggerd by creating manually an invoice for the order inthe Magento admin. For Authorize & capture action, the capture is requested automatically as soon as authorization isconfirmed by Amazon Payments.

6.4.1 Manual capture

To capture the order amount, you must create an invoice first. To create an invoice, login to the Magento admin, openthe order for which you want to capture the amount and click the Invoice button located in the top buttons rows. Please



make sure that the order you want to process has been successfully authorized, which basically means that it is inProcessing state.

After clicking the Invoice button, a new invoice form will appear with most of the crucial data (like products quantity)already filled in. You can adjust some invoice fields if needed. At this point you can create a shipment as well, bychecking Create Shipment checkbox and adding a tracking number if needed. Before submitting the form, pleasemake absolutely sure that Amount selectbox is set to Capture online and press Submit Invoice button. A new invoiceand a new shipment (if checked Create Shipment checkbox) will be created for the order and the capture request issent to Amazon Payments.

Warning: To collect the funds that were authorized, you must capture the amount within 30 days of a successfulauthorization (two days in Sandbox mode). We strongly recommend that you capture funds within seven daysof authorization to reduce the likelihood of declines (within 7 days the a successful captures is guaranteed). Incase your fulfilment process exceeds 30 days, consider using the Manual authorization as payment action in theconfiguration and authorize the payment later in any suitable time (typically in the week before the shipping) beforethe shipping.

6.4. Capturing the payment amount 35


Note: Partial captures are not supported by the extension at this moment.

The capture status, similar to authorizations, will be updated either via IPN message or via data polling, see Synchro-nizing order data for more details.

6.4.2 Automatic capture

In this mode the capture is requested automatically after the successful authorization. Also the invoice that covers allordered items is created automatically. Post-request processing (capture status synchronization) is carried the sameway as in capture invoked manually from Magento backend.

6.5 Refunding order items

The order, which payment has been captured for, can be refunded either fully or partially. Refunds are made againstthe invoices and thus having a paid invoice assigned to the order is a necessary condition that has to be met to refundany order item. Refunds in Magento are recorded as credit memos, so for requesting a refund with Amazon Paymentsyou should create a credit memo first. To create a credit memo login to the Magento admin, open the order you wantrefund, click Invoices tab on the right, select an invoice you want to refund and click on it.

A preview of the selected invoice will appear. Make sure that you are on the single invoice preview page and click theCredit Memo button.



A new credit memo form will appear with most of the crucial data (like products quantity to be refunded) already filledin. If you want to refund the invoice partially (i.e. only a part of the invoiced items) adjust the product quantities tobe refunded (set 0 for items that shall not be refunded) and click Update Qty’s button to update refund totals. You canalso set the refunded items back to stock by checking Return to Stock checkbox. Next choose if you want to refundshipping costs or apply any refunds adjustment and fill in the appropriate fields. Next before submitting the creditmemo form, double check that you have Refund button available and click it. A credit memo will be created and arefund will be requested with Amazon Payments. Its status will be updated either via IPN or data polling, dependingon the update method selected in the extension settings.

6.5. Refunding order items 37


Warning: For the successful refund (recorded in Magento and requested (!) with Amazon Payments) always useRefund button available on the new credit memo form invoked from the single invoice preview page. If you clickCredit Memo button directly on the order page you will be redirected to the new credit memo form with Refundoffline button only, which admittedly will record credit memo in Magento, but surely won’t call refund request atAmazon Payments gateway. If in any case you will get a credit memo with Refund offline button only then surelysomething had to go wrong and you should stop the refund process immediately and start it from the beginningfollowing the above guideline.

6.6 Cancelling an order

For a variety of reasons it sometimes becomes necessary to cancel an order. To cancel an order and notify Amazonabout the payment cancellation:

• Please make sure the amount of the order you want to cancel hasn’t been captured yet,

• Go to Sales → Orders and select the order that you would like to cancel by clicking the Edit button on itsrespective row,

• Click Cancel in order page to remove this order.



6.7 Synchronizing order data

6.7. Synchronizing order data 39



CHAPTER 7

Testing your integration

After a successful configuration, you should test your installation. Only after successfully testing in the Sandbox modeyou should switch to the live environment and make the button visible for all your sellers.

These tests should cover the different workflow that you encounter while processing orders. Both include the standardprocess like receiving an order, invoicing, shipment and alternative processes like canceling orders and refundingorders. Verify that all objects in your Magento admin are in the expected status and you correctly received all orderinformation including the shipping address, contact details and the billing address (if applicable).

Next you should test also declines. You can use the Sandbox Toolbox to simulate soft and hard declines of authoriza-tions. After your testing verify the log files to make sure no exceptions have occurred.

To receive the complete testing scenarios contact Amazon Payments.

7.1 How to create Sandbox test account

To use the sandbox environment, you need to create specific test accounts for the sandbox environment.

• Login into Seller Central.

• Choose the menu Integration → Test accounts.

• Click on Create a new test account.

• Fill in the form using a valid email address. The account can be used immediately after the account creation.

41

https://sellercentral-europe.amazon.com


• Add other delivery addresses to the test account (optional).

42 Chapter 7. Testing your integration

CHAPTER 8

Frequently Asked Questions

8.1 Installation

I have successfully installed Login and Pay with Amazon extension, but when I try to go to the configurationpage System → Configuration → Amazon Payments I am getting: 404 Not Found error.

It’s a Magento bug, the ACL list is not reloaded after the new extension is installed. To solve this issue please logoutfrom the Magento admin and next login again.

It is stated that the extension is compatible with Magento 1.5, but when I try to place an order I am getting anexception: Invalid method Mage_Sales_Model_Order_Payment::lookupTransaction().

Magento 1.5 doesn’t provide public wrapper for _lookupTransaction() method of order payment model, which iscommonly used by Pay with Amazon extension. To fix this issue we have prepared a compatibility pack that rewritescurrent sales/order_payment model. You can install it via Magento Connect, to do so go to System → Magento Connect→ Magento Connect Manager, enter your admin credentials to get logged in, in the Install New Extensions sectionenter http://connect20.creativetest.de/Creativestyle_AmazonPaymentsCompatibilityPack key and click Install button.

Warning: Keep in mind that if any other 3rd party extension rewrites the sales/order_payment model as well,installing Magento 1.5 Compatibility Pack may lead to a rewrite conflict resulting in misfunction of one or moreextensions. It is always advised to test it on a staging system prior to deploy to the production.

8.2 Frontend

How can I disable Pay with Amazon for certain products?

There are few extensions available for disabling payment methods on-the-fly based on the desired conditions. Werecommend to install and use Rico Neitzel’s PaymentFilter for Products and Customer Groups, which Pay withAmazon has been successfully tested against.

Pay with Amazon button doesn’t show up in the cart after the extension is installed and set up.

Lack of Pay with Amazon button in the cart is usually caused by one of the following reasons:

• incorrect Merchant ID set (double check if you don’t have any whitespaces in your Merchant ID),

• incorrect Marketplace set,

43

http://www.magentocommerce.com/magento-connect/paymentfilter-for-products-and-customer-groups.html


• your Amazon seller account is either blocked or not activated (you can check status of your account in AmazonSeller Central).

You can check validity of the provided Amazon Payments credentials using Validate Amazon Payments account buttonavailable in the extension settings. In case you are sure you have Merchant ID and Marketplace correctly set, check ifany of the following extensions is installed and enabled in your shop and follow the instructions:

• Mxperts_NoRegion

• FME_Ajaxaddtocart

Those extensions replace default checkout.cart block with own ones. The replaced block doesn’t include checkoutbuttons defined previously. To bring the Pay with Amazon button back, find appropriate layout file:

• noregion.xml for Mxperts_NoRegion extension,

• ajaxaddtocart.xml for FME_Ajaxaddtocart extension

in your theme folder (or in the default theme folder) and modify checkout.cart.methods and / or check-out.cart.top_methods blocks by adding following code:

<block name="checkout.cart.methods" as="methods" type="core/text_list" translate="label">(...)<block type="amazonpayments/pay_button" name="checkout.cart.methods.amazonpayments_pay.bottom" before="-">

<action method="setIdSuffix"><value>div</value></action><action method="setEnableOr"><value>1</value></action>

</block></block>(...)<block name="checkout.cart.top_methods" as="top_methods" type="core/text_list" translate="label">

(...)<block type="amazonpayments/pay_button" name="checkout.cart.methods.amazonpayments_pay.top" before="-">

<action method="setIdSuffix"><value>top</value></action><action method="setEnableOr"><value>1</value></action>

</block></block>

44 Chapter 8. Frequently Asked Questions

CHAPTER 9

Troubleshooting

Before taking any action, please refer to the Frequently Asked Questions section, where many common issues havebeen already explained and solved.

9.1 Event logs

The Pay with Amazon extension provides a convenient logging system. It is disabled by default, but you can enableit in the extension settings, refer to the Enable logging section for more details.

9.1.1 Log files location

The Logger saves details concerning all exceptions, all API calls and all incoming IPN notifications that occurredwithin the Pay with Amazon extension scope. Logs are stored in CSV files in the following locations:

• exceptions logs:

var/log/amazonpayments/apa_exception.log

• API calls logs:

var/log/amazonpayments/apa_api.log

• IPN notifications logs:

var/log/amazonpayments/apa_ipn.log

9.1.2 Logs accessing

In case you encounter any issues and Frequently Asked Questions section didn’t help, you should review your logs inthe next step. Logs can be accessed in two ways:

• Using creativestyle → Pay with Amazon → Log preview feature, where all logs are displayed on a convenientlist with basic filtering options.

• By directly accessing (using FTP, SFTP or SSH, depending on your server configuration) the above files on yourserver. After the download you can open them with any CSV-capable application. The current log files can bealso downloaded by pressing Download as CSV button on the logs list creativestyle → Pay with Amazon → Logpreview in the Magento admin.

45


9.1.3 Logs rotating

All log files are rotated as soon as they exceed the size of 8 Megabytes, the old log file is renamed then tovar/log/amazonpayments/apa_*.log.timestamp and a new empty file is created for storing the new logentries. The old log files are still accessible by direct access (FTP, SFTP or SSH) to var/log/amazonpaymentsfolder on the server.

9.2 Contact support

In case neither studying the FAQ nor the event logs reviewing resulted in solving your issue you can submit a supportticket on http://creativeticket.de site.

Note: In the request ticket tell us please which extension (Advanced Payment APIs, Checkout by Amazon) doesyour issue concern and describe it very precisely. Some details regarding ecosystem the extension is working within(PHP version, Magento version, extension version, production or staging server) would be also very helpful. Followingthose advices will visibly speed up processing your request.

46 Chapter 9. Troubleshooting

http://creativeticket.de

Date post:	06-Aug-2020
Category:	Documents
Upload:	others
View:	5 times
Download:	0 times

Pay with Amazon Magento extension Documentation · 2019-04-02 · Pay with Amazon Magento extension...

Documents