[IMP] general: add new doc about payment acquirers (#676)
- Updates the main current doc about Payment Acquirers with a completely new doc - Moves some docs from ecommerce to general - redirects - ecommerce/shopper_experience/payment --> general/payment_acquirers/payment_acquirers - ecommerce/shopper_experience/authorize --> general/payment_acquirers/authorize - ecommerce/shopper_experience/paypal --> general/payment_acquirers/paypal - ecommerce/shopper_experience/wire_transfer --> general/payment_acquirers/wire_transfer
@@ -5,10 +5,6 @@ Get paid
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
shopper_experience/payment
|
||||
shopper_experience/paypal
|
||||
shopper_experience/authorize
|
||||
shopper_experience/wire_transfer
|
||||
shopper_experience/payment_acquirer
|
||||
shopper_experience/portal
|
||||
|
||||
|
||||
@@ -1,81 +0,0 @@
|
||||
==================================
|
||||
How to get paid with Authorize.Net
|
||||
==================================
|
||||
|
||||
Authorize.Net is one of the most popular eCommerce payment platforms in North America.
|
||||
Unlike most of the other payment acquirers compatible with Odoo,
|
||||
Authorize.Net can be used as `payment gateway <https://www.authorize.net/solutions/merchantsolutions/pricing/?p=gwo>`__ only.
|
||||
That way you can use the `payment processor or merchant <https://www.authorize.net/partners/resellerprogram/processorlist/>`__ that you like.
|
||||
|
||||
|
||||
Create an Authorize.Net account
|
||||
===============================
|
||||
|
||||
* Create an `Authorize.Net account <https://www.authorize.net>`__
|
||||
by clicking 'Get Started'.
|
||||
* In the pricing page, press *Sign up now* if you want to use Authorize.net as
|
||||
both payment gateway and merchant. If you want to use your own merchant, press
|
||||
the related option.
|
||||
|
||||
.. image:: media/authorize01.png
|
||||
:align: center
|
||||
|
||||
* Go through the registration steps.
|
||||
* The account is set as a test account by default. You can use this test
|
||||
account to process a test transaction from Odoo.
|
||||
* Once ready, switch to **Production** mode.
|
||||
|
||||
|
||||
Set up Odoo
|
||||
===========
|
||||
* Activate Authorize.Net in Odoo from :menuselection:`Website or Sales or Accounting
|
||||
--> Settings --> Payment Acquirers`.
|
||||
* Enter both your **Login ID**
|
||||
your **API Transaction Key** and your **API Signature Key**.
|
||||
|
||||
.. image:: media/authorize02.png
|
||||
:align: center
|
||||
|
||||
To get those credentials from Authorize.Net, you can follow the direction
|
||||
in the Authorize.net Help
|
||||
`API Credentials and Keys <https://account.authorize.net/help/Account/Settings/Security_Settings/General_Settings/API_Login_ID_and_Transaction_Key.htm>`__
|
||||
entry and access the menu :menuselection:`Account --> Settings --> API Credentials & Keys`
|
||||
in the Authorize.net dashboard. Note that you need *both* a Transaction key and and Signature key.
|
||||
|
||||
* Once both keys are set up, you can then generate a Client Key by clicking the
|
||||
"Generate Client Key" button. Note that these 3 keys are necessary for the
|
||||
setup to work correctly.
|
||||
|
||||
|
||||
Go live
|
||||
=======
|
||||
Your configuration is now ready!
|
||||
You can make Authorize.Net visible on your merchant interface
|
||||
and activate the **Enabled** state.
|
||||
|
||||
.. image:: media/paypal_live.png
|
||||
:align: center
|
||||
|
||||
.. note:: Credentials provided by Authorize.net are different for both
|
||||
test and production mode. Don't forget to update them in Odoo when you
|
||||
switch from testing to production or vice-versa.
|
||||
|
||||
|
||||
Assess Authorize.Net as payment solution
|
||||
========================================
|
||||
You can test and assess Authorize.Net for free by creating a `developer account <https://developer.authorize.net>`__.
|
||||
|
||||
Once the account created you receive sandbox credentials.
|
||||
Enter them in Odoo as explained here above and make sure
|
||||
you are still in *Test* mode.
|
||||
|
||||
You can also log in to `Authorize.Net sandbox platform <https://sandbox.authorize.net/>`__
|
||||
to configure your sandbox account.
|
||||
|
||||
To perform ficticious transactions you can use fake card numbers
|
||||
provided in the `Authorize.Net Testing Guide <https://developer.authorize.net/hello_world/testing_guide/>`__.
|
||||
|
||||
.. seealso::
|
||||
|
||||
* :doc:`payment`
|
||||
* :doc:`payment_acquirer`
|
||||
|
Before Width: | Height: | Size: 5.7 KiB |
|
Before Width: | Height: | Size: 5.9 KiB |
|
Before Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 9.9 KiB |
|
Before Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 3.7 KiB |
|
Before Width: | Height: | Size: 5.2 KiB |
|
Before Width: | Height: | Size: 3.9 KiB |
|
Before Width: | Height: | Size: 5.1 KiB |
|
Before Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 6.3 KiB |
|
Before Width: | Height: | Size: 6.4 KiB |
|
Before Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 4.0 KiB |
|
Before Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 9.4 KiB |
|
Before Width: | Height: | Size: 7.9 KiB |
|
Before Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 9.8 KiB |
|
Before Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 7.5 KiB |
|
Before Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 28 KiB |
@@ -1,111 +0,0 @@
|
||||
======================================
|
||||
How to get paid with payment acquirers
|
||||
======================================
|
||||
|
||||
Odoo embeds several payment methods to get paid on eCommerce, Sales
|
||||
and Invoicing apps.
|
||||
|
||||
|
||||
What are the payment methods available
|
||||
======================================
|
||||
|
||||
Wire transfer
|
||||
-------------
|
||||
|
||||
Wire Transfer is the default payment method available. The aim is providing your
|
||||
customers with your bank details so they can pay on their own via their bank.
|
||||
This is very easy to start with but slow and inefficient process-wise.
|
||||
Opt for online acquirers as soon as you can!
|
||||
|
||||
Payment acquirers
|
||||
-----------------
|
||||
|
||||
Redirect your customers to payment platforms to collect money effortless
|
||||
and track the payment status (call-back).
|
||||
Odoo supports more and more platforms over time:
|
||||
|
||||
* `Paypal <paypal.html>`__
|
||||
* Ingenico
|
||||
* Authorize.net
|
||||
* Adyen
|
||||
* Buckaroo
|
||||
* PayUmoney
|
||||
* Sips
|
||||
* Stripe
|
||||
|
||||
|
||||
How to go live
|
||||
==============
|
||||
|
||||
Once the payment method is ready, make it visible in the payment interface
|
||||
by switching the state to **Enabled**.
|
||||
|
||||
.. image:: media/paypal_live.png
|
||||
:align: center
|
||||
|
||||
|
||||
How to let customers save and reuse credit cards
|
||||
================================================
|
||||
To ease the payment of returning customers, you can let them
|
||||
save and reuse a credit card if they want to.
|
||||
If so, a payment token will be saved in Odoo.
|
||||
This option is available with Ingenico and Authorize.net.
|
||||
|
||||
You can turn this on from the acquirer configuration form.
|
||||
|
||||
.. image:: media/payment_save_card.png
|
||||
:align: center
|
||||
|
||||
|
||||
How to debit credit cards to pay subscriptions
|
||||
==============================================
|
||||
`Odoo Subscription <https://www.odoo.com/page/subscriptions>`__ allows to
|
||||
bill services automatically on a recurring basis.
|
||||
Along with it, you can have an automatic debit of the customer's credit card.
|
||||
|
||||
This option is available with Ingenico and Authorize.net.
|
||||
|
||||
You can turn this on from the acquirer configuration form.
|
||||
|
||||
.. image:: media/payment_recurring.png
|
||||
:align: center
|
||||
|
||||
That way a payment token will be recorded when the customer
|
||||
goes for the subscription and an automatic debit will occur
|
||||
whenever an invoice is issued from the subscription.
|
||||
|
||||
|
||||
How to use other acquirers (advanced)
|
||||
=====================================
|
||||
|
||||
Odoo can submit single payment requests and redirect to any payment acquirer.
|
||||
But there is no call-back, i.e. Odoo doesn't track the transaction status.
|
||||
So you will confirm orders manually once you get paid.
|
||||
|
||||
How to:
|
||||
|
||||
* Switch to :doc:`Developer mode <../../../general/developer_mode/activate>`.
|
||||
|
||||
* Take the **Custom** payment method.
|
||||
|
||||
* Set up the payment form (S2S Form Template) as instructed by your payment acquirer.
|
||||
You can start from *default_acquirer_button* that you can duplicate.
|
||||
|
||||
|
||||
Other configurations
|
||||
====================
|
||||
|
||||
Odoo can also be used for more advanced payment processes
|
||||
like installment plans (e.g.
|
||||
`Paypal Installment Plans <https://developer.paypal.com/docs/classic/paypal-payments-standard/integration-guide/installment_buttons>`__).
|
||||
|
||||
Such a customization service is made on-demand by our technical experts
|
||||
based on your own requirements. A business advisor can reach you out for
|
||||
such matter. `Contact us <https://www.odoo.com/page/contactus>`_.
|
||||
|
||||
|
||||
.. seealso::
|
||||
|
||||
* :doc:`paypal`
|
||||
* :doc:`wire_transfer`
|
||||
* :doc:`payment_acquirer`
|
||||
@@ -1,207 +0,0 @@
|
||||
=============================
|
||||
Configure your Paypal account
|
||||
=============================
|
||||
|
||||
Paypal is available and popular worldwide. It doesn’t charge any
|
||||
subscription fee and creating an account is very easy. That’s why we
|
||||
definitely recommend it for starters in Odoo. It works as a seamless
|
||||
flow where the customer is routed to Paypal website to register the
|
||||
payment.
|
||||
|
||||
Paypal account
|
||||
==============
|
||||
|
||||
A business account is needed to get paid with Paypal. Create a
|
||||
`Paypal Business Account <https://www.paypal.com/us/merchantsignup/
|
||||
applicationChecklist?signupType=CREATE_NEW_ACCOUNT&productIntentId=wp_standard>`_
|
||||
or upgrade your Personal account to a Business account. Go to the Paypal
|
||||
settings and click on *Upgrade to a Business account*.
|
||||
Then follow the few configuration steps.
|
||||
|
||||
|
||||
Settings in Paypal
|
||||
==================
|
||||
|
||||
| First, let’s see how to set up your Paypal account in order to build a
|
||||
seamless customer experience with Odoo.
|
||||
| Log in and open the settings. Go to :menuselection:`Products & Services -->
|
||||
Website payments` and click **Update** on **Website preferences**.
|
||||
|
||||
.. image:: media/paypal01.png
|
||||
:align: center
|
||||
|
||||
Auto Return
|
||||
-----------
|
||||
|
||||
*Auto Return* automatically redirects your customers to Odoo once the
|
||||
payment is processed. Check *Auto Return* and enter your domain name
|
||||
with the suffix ``/shop/confirmation`` as *Return URL*
|
||||
(e.g. ``https://yourcompany.odoo.com/shop/confirmation``).
|
||||
|
||||
This URL is requested in Paypal but not used in practice as Odoo
|
||||
transmits it at each transaction. Don’t worry if you manage several
|
||||
sales channels or Odoo databases.
|
||||
|
||||
.. image:: media/paypal02.png
|
||||
:align: center
|
||||
|
||||
Payment Data Transfer (PDT)
|
||||
---------------------------
|
||||
|
||||
*Payment Data Transfer* delivers the payment confirmation to Odoo as
|
||||
soon as it is processed. Without it, Odoo cannot end the sales flow.
|
||||
This setting must be activated as well. When saving, an *Identity
|
||||
Token* is generated. You will be later requested to enter it in Odoo.
|
||||
|
||||
.. image:: media/paypal03.png
|
||||
:align: center
|
||||
|
||||
Paypal Account Optional
|
||||
|
||||
We advise you to not prompt customers to log in with a Paypal account
|
||||
when they get to pay. Let them pay with debit/credit cards as well, or you might lose some deals. Make sure this setting is turned on.
|
||||
|
||||
.. image:: media/paypal04.png
|
||||
:align: center
|
||||
|
||||
Instant Payment Notification (IPN)
|
||||
----------------------------------
|
||||
|
||||
PDT sends order confirmations once and only once. As a result, your site
|
||||
must be running when it happens; otherwise, it will never receive the
|
||||
message. That’s why we advise to activate the *Instant Payment
|
||||
Notification* (IPN) on top. With IPN, delivery of order confirmations
|
||||
is virtually guaranteed since IPN resends a confirmation until your site acknowledges receipt.
|
||||
|
||||
| To activate IPN, get back to *Website payments* menu and click
|
||||
*Update* in *Instant Payment Notification*.
|
||||
| The *Notification URL* to set is your domain name +
|
||||
“payment/paypal/ipn” (e.g. ``https://yourcompany.odoo.com/payment/paypal/ipn``).
|
||||
|
||||
.. image:: media/paypal05.png
|
||||
:align: center
|
||||
|
||||
Payment Messages Format
|
||||
-----------------------
|
||||
|
||||
If you use accented characters (or anything else than basic Latin characters)
|
||||
for your customer names, addresses... you MUST configure the encoding format of
|
||||
the payment request sent by Odoo to Paypal.
|
||||
|
||||
.. danger::
|
||||
|
||||
If you don't configure this setting, some transactions fail without notice.
|
||||
|
||||
To do so, open:
|
||||
|
||||
* `this page for a test account <https://sandbox.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-language-encoding>`__
|
||||
|
||||
* `this page for a production account <https://www.paypal.com/cgi-bin/customerprofileweb?cmd=_profile-language-encoding>`__
|
||||
|
||||
Then, click *More Options* and set the two default encoding formats as **UTF-8**.
|
||||
|
||||
.. image:: media/paypal07.png
|
||||
:align: center
|
||||
|
||||
.. image:: media/paypal08.png
|
||||
:align: center
|
||||
|
||||
Your Paypal account is ready!
|
||||
|
||||
.. tip::
|
||||
If you want your customers to pay without creating a Paypal account,
|
||||
*Paypal Account Optional* needs to be turned on.
|
||||
|
||||
.. image:: media/paypal_account_optional.png
|
||||
|
||||
.. tip::
|
||||
For Encrypted Website Payments & EWP_SETTINGS error,
|
||||
please check the `Paypal documentation <https://developer.paypal.com/docs/
|
||||
classic/paypal-payments-standard/integration-guide/encryptedwebpayments/
|
||||
#encrypted-website-payments-ewp>`_.
|
||||
|
||||
Settings in Odoo
|
||||
================
|
||||
|
||||
Activation
|
||||
----------
|
||||
|
||||
Activate *Paypal* from the config bar of Sales, Invoicing and
|
||||
eCommerce apps, or from the configuration menu of *Payment Acquirers*.
|
||||
|
||||
Credentials
|
||||
-----------
|
||||
|
||||
Odoo requires three Paypal credentials:
|
||||
|
||||
- *Email ID* is your login email address in Paypal.
|
||||
- *Merchant ID* can be found in the settings of your Paypal account, in
|
||||
:menuselection:`Account Settings --> Business information`.
|
||||
- *Paypal PDT Token* is given in *Website payments* configuration as explained here above.
|
||||
|
||||
.. image:: media/paypal09.png
|
||||
:align: center
|
||||
|
||||
Transaction fees
|
||||
----------------
|
||||
|
||||
You can charge extra fees to your customers for paying with Paypal;
|
||||
This to cover the transaction fees Paypal charges you. Once redirected to Paypal, your customer sees an extra applied to the order amount.
|
||||
|
||||
To activate this, go to the Configuration tab of Paypal configuration in
|
||||
Odoo and check *Add Extra Fees*.
|
||||
|
||||
.. image:: media/paypal10.png
|
||||
:align: center
|
||||
|
||||
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.
|
||||
|
||||
Go live!
|
||||
========
|
||||
|
||||
Your configuration is ready to roll. Make sure *Production* mode is
|
||||
on. Then publish the payment method by clicking the *Published* button right next to it.
|
||||
|
||||
.. image:: media/paypal11.png
|
||||
:align: center
|
||||
|
||||
.. image:: media/paypal12.png
|
||||
:align: Center
|
||||
|
||||
Paypal is now available in your payment form available in eCommerce,
|
||||
Sales and Invoicing apps. Customers are redirected to Paypal website
|
||||
when hitting *Pay Now*. They get back to a confirmation page in Odoo
|
||||
once the payment is processed.
|
||||
|
||||
.. image:: media/paypal13.png
|
||||
:align: center
|
||||
|
||||
Test environment
|
||||
================
|
||||
|
||||
You can test the entire payment flow in Odoo thanks to Paypal Sandbox accounts.
|
||||
|
||||
Log in to `Paypal Developer Site <https://developer.paypal.com/>`__ with your Paypal credentials.
|
||||
|
||||
This will create two sandbox accounts:
|
||||
|
||||
- A business account (to use as merchant, e.g. `pp.merch01-facilitator@example.com <mailto:pp.merch01-facilitator@example.com>`__).
|
||||
|
||||
- A default personal account (to use as shopper, e.g. `pp.merch01-buyer@example.com <mailto:pp.merch01-buyer@example.com>`__).
|
||||
|
||||
Log in to Paypal Sandbox with the merchant account and follow the same configuration instructions.
|
||||
Enter your sandbox credentials in Odoo and make sure Paypal is still
|
||||
set on *Test Environment*. Also, make sure the automatic invoicing
|
||||
is not activated in your eCommerce settings, to not generate invoices
|
||||
when a fictitious transaction is completed.
|
||||
|
||||
Run a test transaction from Odoo using the sandbox personal account.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`payment`
|
||||
- :doc:`payment_acquirer`
|
||||
@@ -1,42 +0,0 @@
|
||||
=======================================
|
||||
How to get paid with wire transfers
|
||||
=======================================
|
||||
|
||||
**Wire Transfer** is the default payment method available.
|
||||
The aim is providing your customers with your bank details
|
||||
so they can pay on their own.
|
||||
This is very easy to start with but slow and inefficient process-wise.
|
||||
Opt for payment acquirers as soon as you can!
|
||||
|
||||
|
||||
How to provide customers with payment instructions
|
||||
==================================================
|
||||
Put your payment instructions in the **Thanks Message** of your payment method.
|
||||
|
||||
.. image:: media/payment_instructions.png
|
||||
:align: center
|
||||
|
||||
They will appear to the customers when they place an order.
|
||||
|
||||
.. image:: media/payment_customer_instructions.png
|
||||
:align: center
|
||||
|
||||
|
||||
How to manage an order once you get paid
|
||||
========================================
|
||||
|
||||
Whenever a customer pays by wire transfer, the order stays in an
|
||||
intermediary stage **Quotation Sent** (i.e. unpaid order).
|
||||
When you get paid,
|
||||
you confirm the order manually to launch the delivery.
|
||||
|
||||
|
||||
How to create other manual payment methods
|
||||
==========================================
|
||||
|
||||
If you manage a B2B business, you can create other manually-processed
|
||||
payment methods like paying by check.
|
||||
To do so, just rename *Wire Transfer* or duplicate it.
|
||||
|
||||
.. image:: media/payment_check.png
|
||||
:align: center
|
||||