[IMP] payment providers: PayPal
taskid-3184602.
16.0 -> Change extra fees category to :ref: main page payment provider
16.2 -> Remove Odoo credentials section
Remove PDT identity token
Remove merchant ID note
Remove test mode section on environment test
Took the opportunity to redo the whole page.
closes odoo/documentation#4396
Signed-off-by: Tom Aarab (toaa) <toaa@odoo.com>
This commit is contained in:
Tom Aarab (toaa)
parent
b675584730
commit
bf327d9200
@ -1,109 +1,82 @@
|
|||||||
======
|
======
|
||||||
Paypal
|
PayPal
|
||||||
======
|
======
|
||||||
|
|
||||||
`Paypal <https://www.paypal.com/>`_ is available and popular worldwide. It doesn't charge any
|
`Paypal <https://www.paypal.com/>`_ is an American online payment acquirer available worldwide, and
|
||||||
subscription fee, and creating an account is very easy. That's why we recommend it for starters in
|
one of the few that does not charge a subscription fee.
|
||||||
Odoo. It works as a seamless flow where the customer is routed to the Paypal website to register the
|
|
||||||
payment.
|
|
||||||
|
|
||||||
Settings in Odoo
|
Settings in PayPal
|
||||||
================
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
- :ref:`payment_acquirers/add_new`
|
|
||||||
|
|
||||||
Credentials tab
|
|
||||||
---------------
|
|
||||||
|
|
||||||
Odoo needs your **API Credentials** to connect with your PayPal account, which comprise:
|
|
||||||
|
|
||||||
- **Email**: your login email address in Paypal.
|
|
||||||
- **PDT Identity Token**: the key used to verify the authenticity of transactions.
|
|
||||||
- **Use IPN**: whether you want to use Instant Payment Notification. Already checked, you don't have
|
|
||||||
to change it.
|
|
||||||
|
|
||||||
You can copy your credentials from your Paypal account and paste them into the related fields under
|
|
||||||
the **Credentials** tab.
|
|
||||||
|
|
||||||
|
|
||||||
To set the **PDT Identity Token**, switch to :ref:`developer mode <developer-mode>` and retrieve the
|
|
||||||
token by following the configuration step :ref:`paypal/enable-pdt`.
|
|
||||||
|
|
||||||
.. important::
|
|
||||||
If you are trying Paypal as a test, using a :ref:`Paypal Sandbox account <paypal/testing>`,
|
|
||||||
change the **State** to *Test Mode*. We recommend doing this on a test Odoo database rather than
|
|
||||||
on your main database.
|
|
||||||
|
|
||||||
Fees tab
|
|
||||||
--------
|
|
||||||
|
|
||||||
You can charge extra fees to your customers for paying with Paypal to cover the transaction fees
|
|
||||||
Paypal charges you. Once redirected to Paypal, your customer sees an extra amount applied to the
|
|
||||||
order amount.
|
|
||||||
|
|
||||||
To activate this, go to Paypal configuration's :guilabel:`Fees` tab in Odoo and activate
|
|
||||||
:guilabel:`Add Extra Fees`.
|
|
||||||
|
|
||||||
You can refer to `Paypal Fees <https://www.paypal.com/webapps/mpp/paypal-fees>`_ to set up fees.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
`Traders in the EU <https://europa.eu/youreurope/citizens/consumers/shopping/pricing-payments/
|
|
||||||
index_en.htm>`_ are not allowed to charge extra fees for paying with credit cards.
|
|
||||||
|
|
||||||
Settings in Paypal
|
|
||||||
==================
|
==================
|
||||||
|
|
||||||
First, set up your Paypal account to build a seamless customer experience with Odoo.
|
To access your PayPal account settings, log into PayPal, open the :guilabel:`Account Settings`, and
|
||||||
|
open the :guilabel:`Website payments` menu.
|
||||||
|
|
||||||
Log into your PayPal account and open the account settings. Then, go to :menuselection:`Account menu
|
.. image:: paypal/paypal-account.png
|
||||||
--> Account settings --> Website payments`.
|
:align: center
|
||||||
|
:alt: PayPal account menu
|
||||||
|
|
||||||
Enable Auto Return
|
.. important::
|
||||||
------------------
|
Note that for PayPal to work **in Odoo**, the options :ref:`Auto Return <paypal/auto-return>`,
|
||||||
|
:ref:`PDT <paypal/pdt>`, and :ref:`IPN <paypal/ipn>` **must** all be enabled.
|
||||||
|
|
||||||
The *Auto Return* feature automatically redirects your customers to Odoo once the payment is
|
.. _paypal/auto-return:
|
||||||
processed.
|
|
||||||
|
|
||||||
From the *Website payments* settings page, go to :menuselection:`Website preferences --> Update -->
|
Auto Return
|
||||||
Auto return for website payments` and select **On**. Enter the address of your Odoo database (e.g.,
|
-----------
|
||||||
`https://yourcompany.odoo.com`) in the **Return URL** field.
|
|
||||||
|
The **Auto Return** feature automatically redirects customers to Odoo once the payment is processed.
|
||||||
|
|
||||||
|
From :guilabel:`Website payments`, go to :menuselection:`Website preferences --> Update --> Auto
|
||||||
|
return for website payments --> Auto return` and select :guilabel:`On`. Enter the address of your
|
||||||
|
Odoo database (e.g., `https://yourcompany.odoo.com`) in the :guilabel:`Return URL` field, and
|
||||||
|
:guilabel:`Save`.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
Any URL will do the job. Odoo only needs the setting to be enabled since it uses another URL.
|
Any URL does the job. Odoo only needs the setting to be enabled since it uses another URL.
|
||||||
|
|
||||||
.. _paypal/enable-pdt:
|
.. _paypal/pdt:
|
||||||
|
|
||||||
Enable Payment Data Transfer (PDT)
|
Payment Data Transfer (PDT)
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
:abbr:`PDT (Payment Data Transfer)` allows to receive payment confirmations, displays the payment
|
||||||
|
status to the customers, and verifies the authenticity of the payments. From :menuselection:`Website
|
||||||
|
preferences --> Update`, scroll down to :guilabel:`Payment data transfer` and select :guilabel:`On`.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
PayPal displays your **PDT Identity Token** as soon as :ref:`Auto return <paypal/auto-return>`
|
||||||
|
and :ref:`Payment Data Transfer (PDT) <paypal/pdt>` are enabled. If you need the **PDT Identity
|
||||||
|
Token**, disable and re-enable :guilabel:`Payment data transfer` to display the token again.
|
||||||
|
|
||||||
|
.. _paypal/ipn:
|
||||||
|
|
||||||
|
Instant Payment Notification (IPN)
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
|
||||||
Enable the *Payment Data Transfer* feature to receive payment confirmations immediately. This
|
:abbr:`IPN (Instant Payment Notifications)` is similar to **PDT**, but allows for more
|
||||||
feature also displays the payment status to the customers and verifies the authenticity of the
|
notifications, such as chargeback notifications. To enable **IPN**, go to :menuselection:`Website
|
||||||
payments.
|
payments --> Instant payment notifications --> Update` and click :guilabel:`Choose IPN settings`.
|
||||||
|
Enter a :guilabel:`Notification URL`, select :guilabel:`Receive IPN messages (Enabled)`, and
|
||||||
|
:guilabel:`Save`.
|
||||||
|
|
||||||
From the *Website payments* settings page, go to :menuselection:`Website preferences --> Update -->
|
PayPal Account Optional
|
||||||
Payment data transfer` and select **On**. PayPal displays your **PDT Identity Token** as soon as
|
|
||||||
the change is saved.
|
|
||||||
|
|
||||||
Paypal Account Optional
|
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
We advise you to not prompt customers to log in with a Paypal account when they get to pay. Let them
|
We advise not to prompt customers to log in with a PayPal account upon payment. It is better and
|
||||||
pay with debit/credit cards as well, or you might lose some deals. Make sure this setting is turned
|
more accessible for customers to pay with a debit/credit card. To disable that prompt, go to
|
||||||
on.
|
:menuselection:`Account Settings --> Website payments --> Update` and select :guilabel:`On` for
|
||||||
|
:guilabel:`PayPal account optional`.
|
||||||
|
|
||||||
Payment Messages Format
|
Payment Messages Format
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
Suppose you use accented characters (or anything else than primary Latin characters) for your
|
If you use accented characters (or anything other than primary Latin characters) for customer names
|
||||||
customer names or addresses. In that case, you **must** configure the encoding format of the payment
|
or addresses, then you **must** configure the encoding format of the payment request sent by Odoo to
|
||||||
request sent by Odoo to Paypal. Otherwise, some transactions fail without notice.
|
PayPal. If you do not, some transactions fail without notice.
|
||||||
|
|
||||||
To do so, go to `your production account <https://www.paypal.com/cgi-bin/customerprofileweb
|
To do so, go to `your production account <https://www.paypal.com/cgi-bin/customerprofileweb
|
||||||
?cmd=_profile-language-encoding>`_. Then, click *More Options* and set the two default encoding
|
?cmd=_profile-language-encoding>`_. Then, click :guilabel:`More Options` and set the two default
|
||||||
formats as **UTF-8**.
|
encoding formats as :guilabel:`UTF-8`.
|
||||||
|
|
||||||
Your Paypal account is ready!
|
|
||||||
|
|
||||||
.. tip::
|
.. tip::
|
||||||
- For Encrypted Website Payments & EWP_SETTINGS error, please check the `Paypal documentation
|
- For Encrypted Website Payments & EWP_SETTINGS error, please check the `Paypal documentation
|
||||||
@ -113,6 +86,52 @@ Your Paypal account is ready!
|
|||||||
`link <https://sandbox.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-language-encoding>`_
|
`link <https://sandbox.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-language-encoding>`_
|
||||||
to configure the encoding format in a test environment.
|
to configure the encoding format in a test environment.
|
||||||
|
|
||||||
|
Settings in Odoo
|
||||||
|
================
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
:ref:`payment_acquirers/add_new`
|
||||||
|
|
||||||
|
Credentials
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Odoo needs your **API Credentials** to connect with your PayPal account. To do so, go to
|
||||||
|
:menuselection:`Accounting --> Configuration --> Payment Acquirers` and :guilabel:`Activate` PayPal.
|
||||||
|
Then, enter your PayPal account credentials in the :guilabel:`Credentials` tab:
|
||||||
|
|
||||||
|
- :guilabel:`Email`: the login email address in Paypal;
|
||||||
|
- :guilabel:`PDT Identity Token`: the key used to verify the authenticity of transactions;
|
||||||
|
- :guilabel:`Use IPN`: enable for PayPal to work properly in Odoo.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
Save the :guilabel:`PDT Identity Token` for later use.
|
||||||
|
|
||||||
|
To set the :guilabel:`PDT Identity Token`, switch to :ref:`developer mode <developer-mode>` and
|
||||||
|
retrieve the token by following the configuration steps at :ref:`paypal/pdt`.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
The PayPal **Merchant ID** is not required in Odoo.
|
||||||
|
.. important::
|
||||||
|
If you are trying PayPal as a test, using a :ref:`PayPal Sandbox account <paypal/testing>`,
|
||||||
|
change the :guilabel:`State` to :guilabel:`Test Mode`. We recommend doing this on a test Odoo
|
||||||
|
database rather than on your main database.
|
||||||
|
|
||||||
|
Extra fees
|
||||||
|
----------
|
||||||
|
|
||||||
|
You can charge **extra fees** to customers choosing to pay with PayPal in order to cover the
|
||||||
|
transaction fees PayPal charges you. Once redirected to Paypal, your customer sees an extra amount
|
||||||
|
applied to the order amount.
|
||||||
|
|
||||||
|
To activate this option, go to :menuselection:`Accounting --> Configuration --> Payment Acquirers`
|
||||||
|
and select :guilabel:`PayPal`. Then, go to the :guilabel:`Fees` tab and tick the :guilabel:`Add
|
||||||
|
Extra Fees` box.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
- You can refer to `Paypal Fees <https://www.paypal.com/webapps/mpp/paypal-fees>`_ to set up
|
||||||
|
fees.
|
||||||
|
- `Traders in the EU <https://europa.eu/youreurope/citizens/consumers/shopping/pricing-payments/index_en.htm>`_ are not allowed to charge extra fees for paying with credit cards.
|
||||||
|
|
||||||
.. _paypal/testing:
|
.. _paypal/testing:
|
||||||
|
|
||||||
Test environment
|
Test environment
|
||||||
@ -121,19 +140,21 @@ Test environment
|
|||||||
Configuration
|
Configuration
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
Thanks to Paypal Sandbox accounts, you can test the entire payment flow in Odoo.
|
Thanks to PayPal sandbox accounts, you can test the entire payment flow in Odoo.
|
||||||
|
|
||||||
Log into the `Paypal Developer Site <https://developer.paypal.com/>`_ using your Paypal
|
Log into the `Paypal Developer Site <https://developer.paypal.com/>`_ using your PayPal credentials,
|
||||||
credentials, which creates two sandbox accounts:
|
which creates two sandbox accounts:
|
||||||
|
|
||||||
- A business account (to use as merchants, e.g.,
|
- A business account (to use as merchants, e.g.,
|
||||||
`pp.merch01-facilitator@example.com <mailto:pp.merch01-facilitator@example.com>`_).
|
`pp.merch01-facilitator@example.com <mailto:pp.merch01-facilitator@example.com>`_);
|
||||||
- A default personal account (to use as shoppers, e.g.,
|
- A default personal account (to use as shoppers, e.g.,
|
||||||
`pp.merch01-buyer@example.com <mailto:pp.merch01-buyer@example.com>`_).
|
`pp.merch01-buyer@example.com <mailto:pp.merch01-buyer@example.com>`_).
|
||||||
|
|
||||||
Log into Paypal Sandbox using the merchant account and follow the same configuration instructions.
|
Log into PayPal sandbox using the merchant account and follow the same configuration instructions.
|
||||||
Enter your sandbox credentials in Odoo and ensure Paypal is set on *Test Mode*. We recommend doing
|
Enter your sandbox credentials in Odoo (:menuselection:`Accounting --> Configuration --> Payment
|
||||||
this on a test Odoo database rather than your main database.
|
Acquirer --> PayPal` in the :guilabel:`Credentials` tab, and make sure the status is set on
|
||||||
|
:guilabel:`Test Mode`. We recommend doing this on a test Odoo database rather than your main
|
||||||
|
database.
|
||||||
|
|
||||||
Run a test transaction from Odoo using the sandbox personal account.
|
Run a test transaction from Odoo using the sandbox personal account.
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Loading…
Reference in New Issue
Block a user