-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfiguration.rst
186 lines (121 loc) · 6.84 KB
/
configuration.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
.. _configuration:
Configuration
=============
After the successful installation you can proceed to the configuration. In OpenMage admin go to :menuselection:`creativestyle --> Amazon Pay and Login with Amazon --> Settings` (or :menuselection:`System --> Configuration --> Amazon Payments` tab).
.. image:: /images/configuration_1.png
Available options are grouped into two main sections: :guilabel:`Account credentials` and :guilabel:`Configuration` (with :guilabel:`Expert Mode` subsection).
.. _configuration-account-credentials:
Account credentials
-------------------
In this section you can define your Amazon Payments seller account credentials.
.. _configuration-credentials:
:guilabel:`Payment Region, Merchant ID and Client ID`
'''''''''''''''''''''''''''''''''''''''''''''''''''''
Fill out those fields with your Amazon Payments seller credentials. You can find them in the Amazon Seller Central.
.. _configuration-private-key:
:guilabel:`Private Key and Public Key ID`
'''''''''''''''''''''''''''''''''''''''''
Fill out those fields with the Private Key generated in Amazon Seller Central and the corresponding Public Key ID.
----
.. _configuration-advanced:
Advanced configuration
----------------------
.. _configuration-operation-mode:
:guilabel:`Operation mode`
''''''''''''''''''''''''''
Sandbox mode has been designed to test the **Amazon Pay** service. In sandbox mode the selected payment method is not charged. In general, sandbox mode should be enabled for development and staging environments for testing and always has to be disabled for production environments. Never show the sandbox buttons and widgets to buyers in your live environment.
.. _configuration-payment-action:
:guilabel:`Payment Action`
''''''''''''''''''''''''''
You can select the desired payment action taken after an order is placed. Available options are:
* :guilabel:`Authorize` (default) - order reference creation is followed by automatic authorization request. Capture must be requested manually by creating an invoice with `Capture online` option selected.
* :guilabel:`Authorize & capture` - order reference creation is followed by automatic authorization and capture request.
.. _configuration-expert-mode:
----
Expert Mode
-----------
Please click on the :guilabel:`Expert Mode` link to reveal the most advanced configuration options.
----
Frontend
~~~~~~~~
.. _configuration-frontend-display-language:
:guilabel:`Display language`
''''''''''''''''''''''''''''
In this option you can select a language which will be used for displaying all elements (forms, widgets) generated by Amazon Pay. Selected language will be also used to localize emails sent by Amazon Payments to the customer after purchase.
----
Amazon Sign-in
~~~~~~~~~~~~~~
.. _configuration-login-with-amazon-enable:
:guilabel:`Enable`
''''''''''''''''''
By switching this option you can enable or disable **Amazon Sign-in** feature. Amazon Sign-in allows users to login to your shop using their Amazon username and password. The name, email address and user id is fetched from Amazon in order to facilitate the creation of an OpenMage account. Shipping and billing address will be retrieved as part of the checkout.
.. _configuration-login-with-amazon-button-color:
:guilabel:`Button color`
''''''''''''''''''''''''
In this option you can select the desired color of :guilabel:`Amazon Sign-in` button. The following predefined colors ara available:
* :guilabel:`Gold`
* :guilabel:`Light gray`
* :guilabel:`Dark gray`
----
Amazon Pay
~~~~~~~~~~
.. _configuration-amazon-pay-enable:
:guilabel:`Enable`
''''''''''''''''''
By switching this option you can enable or disable **Amazon Pay**. This option must be set to :guilabel:`Yes` if you want to provide payment service to your customers.
.. _configuration-amazon-pay-pdp:
:guilabel:`Display on Product Details Page`
'''''''''''''''''''''''''''''''''''''''''''
By switching this option you can enable or disable :guilabel:`Amazon Pay` button on the product details page. :guilabel:`Amazon Pay` button on the product details page allows the buyer to add the product to the cart and init the checkout with just one click.
.. _configuration-amazon-pay-button-color:
:guilabel:`Button color`
''''''''''''''''''''''''
In this option you can select the desired color of :guilabel:`Amazon Pay` button. The following predefined colors ara available:
* :guilabel:`Gold`
* :guilabel:`Light gray`
* :guilabel:`Dark gray`
----
Delivery restrictions
~~~~~~~~~~~~~~~~~~~~~
.. _configuration-delivery-restrictions-packstation:
:guilabel:`Restrict packstation addresses`
''''''''''''''''''''''''''''''''''''''''''
By enabling this option you will restrict delivery to the addresses identified as packstations.
.. _configuration-delivery-restrictions-po-box:
:guilabel:`Restrict PO box addresses`
'''''''''''''''''''''''''''''''''''''
By enabling this option you will restrict delivery to the addresses identified as PO Boxes.
----
Communication
~~~~~~~~~~~~~
.. _configuration-communication-store-name:
:guilabel:`Store name`
''''''''''''''''''''''
The value set for this option will appear as your store name on all email send by Amazon Pay.
.. _configuration-communication-soft-descriptor:
:guilabel:`Display name on bank account statement`
''''''''''''''''''''''''''''''''''''''''''''''''''
Use this option to set the name of your store shown on the bank account statements. The maximum length of the value for this option is 16 chars.
----
Alexa Delivery Notifications
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _configuration-alexa-delivery-enable:
:guilabel:`Enable Delivery Notifications`
'''''''''''''''''''''''''''''''''''''''''
Alexa delivery notifications for Amazon Pay merchants allow you to pro-actively inform your customers if their order is on its way or has arrived.
.. _configuration-alexa-delivery-carrier-codes:
:guilabel:`Carrier codes`
'''''''''''''''''''''''''
This option allows to map carriers from your shop to the Amazon Pay predefined carriers. Please use the Carrier codes form by selecting your available carriers and assign them to the matching one in the Amazon Pay carrier list.
.. image:: /images/alexa_carrier_mapping.gif
----
Developer options
~~~~~~~~~~~~~~~~~
.. _configuration-developer-enable-logging:
:guilabel:`Enable logging`
''''''''''''''''''''''''''
The Pay with Amazon extension comes with a dedicated logging mechanism. If this option is enabled all exceptions and API calls will be saved to the appropriate log file in :file:`var/log/amazonpayments/v2` directory in your OpenMage installation.
.. _configuration-developer-allowed-ips:
:guilabel:`Allowed IPs (comma separated)`
'''''''''''''''''''''''''''''''''''''''''
For testing or debugging purposes you can restrict access to **Amazon Pay** checkout in your shop to certain IP numbers only. :guilabel:`Amazon Pay` button will be shown only for the visitors coming from allowed IPs. You can set more than one allowed IP separated with commas.