diff --git a/ecommerce/shopper_experience.rst b/ecommerce/shopper_experience.rst index c20d12956..ec7aab789 100644 --- a/ecommerce/shopper_experience.rst +++ b/ecommerce/shopper_experience.rst @@ -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 diff --git a/ecommerce/shopper_experience/media/payment_recurring.png b/ecommerce/shopper_experience/media/payment_recurring.png deleted file mode 100644 index ca6cf2e75..000000000 Binary files a/ecommerce/shopper_experience/media/payment_recurring.png and /dev/null differ diff --git a/ecommerce/shopper_experience/media/payment_save_card.png b/ecommerce/shopper_experience/media/payment_save_card.png deleted file mode 100644 index 71dedd42a..000000000 Binary files a/ecommerce/shopper_experience/media/payment_save_card.png and /dev/null differ diff --git a/ecommerce/shopper_experience/payment.rst b/ecommerce/shopper_experience/payment.rst deleted file mode 100644 index c4d4f0668..000000000 --- a/ecommerce/shopper_experience/payment.rst +++ /dev/null @@ -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 `__ -* 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 `__ 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 `__). - -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 `_. - - -.. seealso:: - - * :doc:`paypal` - * :doc:`wire_transfer` - * :doc:`payment_acquirer` \ No newline at end of file diff --git a/general.rst b/general.rst index 6ed8a21ad..bbf93fe16 100644 --- a/general.rst +++ b/general.rst @@ -12,5 +12,6 @@ General general/base_import general/auth general/tags + general/payment_acquirers general/in_app_purchase general/developer_mode diff --git a/general/payment_acquirers.rst b/general/payment_acquirers.rst new file mode 100644 index 000000000..73c514348 --- /dev/null +++ b/general/payment_acquirers.rst @@ -0,0 +1,11 @@ +================= +Payment Acquirers +================= + +.. toctree:: + :titlesonly: + + payment_acquirers/payment_acquirers + payment_acquirers/wire_transfer + payment_acquirers/paypal + payment_acquirers/authorize diff --git a/ecommerce/shopper_experience/authorize.rst b/general/payment_acquirers/authorize.rst similarity index 97% rename from ecommerce/shopper_experience/authorize.rst rename to general/payment_acquirers/authorize.rst index 615bd8cf9..021da790e 100644 --- a/ecommerce/shopper_experience/authorize.rst +++ b/general/payment_acquirers/authorize.rst @@ -77,5 +77,5 @@ provided in the `Authorize.Net Testing Guide ` + | When selected, Odoo displays your payment information with a payment reference. You have to + approve the payment manually once you have received it on your bank account. +- | SEPA Direct Debit + | Your customers can sign a SEPA Direct Debit mandate online and get their bank account charged + directly. :doc:`Click here <../../accounting/receivables/customer_payments/batch_sdd>` for more + information about this payment method. + +.. _payment_acquirers/online_providers: + +Online Payment Providers +------------------------ + ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| | Redirection to | Payment | Save Cards | Capture Amount | +| | the acquirer website | from Odoo | | Manually | ++=====================================+======================+===========+============+=================+ +| Adyen | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Alipay | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| :doc:`Authorize.Net ` | ✔ | ✔ | ✔ | ✔ | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Buckaroo | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Ingenico | ✔ | ✔ | ✔ | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| :doc:`PayPal ` | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| PayUMoney | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| SIPS | ✔ | | | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ +| Stripe | ✔ | ✔ | ✔ | | ++-------------------------------------+----------------------+-----------+------------+-----------------+ + +.. note:: + Some of these Online Payment Providers can also be added as :doc:`Bank Accounts + <../../accounting/bank/setup/bank_accounts>`, but this is **not** the same process as adding them + as Payment Acquirers. Payment Acquirers allow customers to pay online, and Bank Accounts are + added and configured on your Accounting app to do a bank reconciliation, which is an accounting + control process. + +.. _payment_acquirers/configuration: + +Configuration +============= + +Some of the features described in this section are available only with some Payment Acquirers. Refer +to :ref:`the table above ` for more details. + +.. _payment_acquirers/add_new: + +Add a new Payment Acquirer +-------------------------- + +To add a new Payment acquirer and make it available to your customers, go to +:menuselection:`Accounting --> Configuration --> Payment Acquirers`, look for your payment acquirer, +install the related module, and activate it. To do so, open the payment acquirer and change its +state from *Disabled* to *Enabled*. + +.. image:: media/payment-acquirers-activation.png + :align: center + :alt: Click on install, then on activate to make the payment acquirer available on Odoo. + +.. warning:: + We recommend using the *Test Mode* on a duplicated database or a test database. The Test Mode is + meant to be used with your test/sandbox credentials, but Odoo generates Sales Orders and Invoices + as usual. It isn't always possible to cancel an invoice, and this could create some issues with + your invoices numbering if you were to test your payment acquirers on your main database. + +.. _payment_acquirers/credentials_tab: + +Credentials tab +~~~~~~~~~~~~~~~ + +If not done yet, go to the **Online Payment Provider**'s website, create an account, and make sure +to have the credentials required for third-party use. Odoo requires these credentials to communicate +with the Payment Acquirer and get the confirmation of the *payment authentication*. + +The form in this section is specific to the Payment Acquirer you are configuring. Please refer to +the related documentation for more information. + +.. _payment_acquirers/configuration_tab: + +Configuration tab +~~~~~~~~~~~~~~~~~ + +You can change the Payment Acquirer front-end appearance by modifying its name under the **Displayed +as** field and which credit card icons to display under the **Supported Payment Icons** field. + +.. _payment_acquirers/save_cards: + +Save and reuse Credit Cards +*************************** + +With the **Save Cards** feature, Odoo can store **Payment Tokens** in your database, which can be +used for subsequent payments, without having to reenter the payment details. This is particularly +useful for subscriptions' recurring payments. + +.. _payment_acquirers/capture_amount: + +Place a hold on a card +********************** + +If the **Capture Amount Manually** field is enabled, the funds are reserved for a few days on the +customer's card, but not charged yet. You must then go to the related Sales Order and manually +*capture* the funds before its automatic cancellation, or *void the transaction* to unlock the funds +from the customer's card. + +.. _payment_acquirers/payment_flow: + +Payment Flow +************ + +Choose in the **Payment Flow** field if to redirect the user to the payment acquirer's portal to +authenticate the payment, or if to stay on the current page and authenticate the payment from Odoo. + +.. note:: + Some features are available only if you select *Redirection to the acquirer website*. + +.. _payment_acquirers/countries: + +Countries +********* + +Restrict the use of the Payment Acquirer to a selection of countries. Leave this field blank to make +the Payment Acquirer available to all countries. + +.. _payment_acquirers/journal: + +Payment Journal +*************** + +The **Payment Journal** selected for your Payment Acquirer must be a *Bank* journal. + +.. important:: + In many cases, Odoo automatically creates a new **Journal** and a new **Account** when you + activate a new Payment Acquirer. Both of them are preset to work out-of-the-box, but we strongly + recommend you to make sure these fields are correctly set according to your accounting needs, and + adapt them if necessary. + +.. _payment_acquirers/messages: + +Messages tab +~~~~~~~~~~~~ + +Change here the messages displayed by Odoo after a payment's confirmation or failure. + +.. _payment_acquirers/accounting: + +Accounting perspective +====================== + +The **Bank Payments** that go directly to one of your bank accounts follow their usual +reconciliation workflows. However, payments recorded with **Online Payment Providers** require you +to consider how you want to record your payments' journal entries. We recommend you to ask your +accountant for advice. + +Odoo default method is to record the payments on a *Current Assets Account*, on a dedicated *Bank +Journal*, once the *Payment Authentication* is confirmed. At some point, you transfer the funds from +the *Payment Acquirer* to your *Bank Account*. + +Here are the requirements for this to work: + +- Bank Journal + + - The Journal's **type** must be *Bank Journal*. + - Select the right **Default Debit Account** and **Default Credit Account**. + - | Under the *Advanced Settings* tab, make sure that **Posting** is set as *Post At Payment + Validation*. + | This implies that the Journal Entry is recorded directly when your Odoo database receives the + confirmation of the *Payment Authentication* from the Online Payment Provider. + +- Current Asset Account + + - The Account's **type** is *Current Assets* + - The Account must **Allow Reconciliation** + +.. note:: + In many cases, Odoo automatically creates a new **Journal** and a new **Current Asset Account** + when you activate a new Payment Acquirer. You can modify them if necessary. + +.. seealso:: + + - :doc:`../../accounting/receivables/customer_payments/recording` + - :doc:`wire_transfer` + - :doc:`authorize` + - :doc:`paypal` \ No newline at end of file diff --git a/ecommerce/shopper_experience/paypal.rst b/general/payment_acquirers/paypal.rst similarity index 98% rename from ecommerce/shopper_experience/paypal.rst rename to general/payment_acquirers/paypal.rst index 8c79f0887..bbf7a4d06 100644 --- a/ecommerce/shopper_experience/paypal.rst +++ b/general/payment_acquirers/paypal.rst @@ -203,5 +203,5 @@ when a fictitious transaction is completed. Run a test transaction from Odoo using the sandbox personal account. .. seealso:: - - :doc:`payment` - - :doc:`payment_acquirer` + - :doc:`payment_acquirers` + - :doc:`../../ecommerce/shopper_experience/payment_acquirer` diff --git a/ecommerce/shopper_experience/wire_transfer.rst b/general/payment_acquirers/wire_transfer.rst similarity index 100% rename from ecommerce/shopper_experience/wire_transfer.rst rename to general/payment_acquirers/wire_transfer.rst diff --git a/redirects.txt b/redirects.txt index 65c6e079d..d2395b190 100644 --- a/redirects.txt +++ b/redirects.txt @@ -146,3 +146,8 @@ helpdesk/reinvoice_from_project.rst helpdesk/timesheet_and_invoice/reinvoice_fro planning/duplicate_a_planning.rst planning/overview/duplicate_a_planning.rst # (#567) planning/send_planned_shifts.rst planning/overview/send_planned_shifts.rst # (#567) + +ecommerce/shopper_experience/payment.rst general/payment_acquirers/payment_acquirers.rst # ecommerce/shopper_experience/payment --> general/payment_acquirers/payment_acquirers +ecommerce/shopper_experience/authorize.rst general/payment_acquirers/authorize.rst # ecommerce/shopper_experience/* --> general/payment_acquirers/* +ecommerce/shopper_experience/paypal.rst general/payment_acquirers/paypal.rst # ecommerce/shopper_experience/* --> general/payment_acquirers/* +ecommerce/shopper_experience/wire_transfer.rst general/payment_acquirers/wire_transfer.rst # ecommerce/shopper_experience/* --> general/payment_acquirers/* \ No newline at end of file diff --git a/sales/send_quotations/get_paid_to_validate.rst b/sales/send_quotations/get_paid_to_validate.rst index b05eb8ee0..5731f7c1b 100644 --- a/sales/send_quotations/get_paid_to_validate.rst +++ b/sales/send_quotations/get_paid_to_validate.rst @@ -22,9 +22,9 @@ feature. There, you will have direct access to the **Payment Acquirers** page. It will allow you to select and configure your acquirers of choice. Before creating or modifying a payment acquirer, be sure to check out our documentation about how to be paid with payment acquirers such as -:doc:`../../ecommerce/shopper_experience/paypal`, -:doc:`../../ecommerce/shopper_experience/authorize`, and others in the :doc:`../../ecommerce` -documentation. +:doc:`../../general/payment_acquirers/paypal`, +:doc:`../../general/payment_acquirers/authorize`, and others in the +:doc:`../../general/payment_acquirers` documentation. .. note:: If you are familiar with this documentation: :doc:`quote_template`; you @@ -48,8 +48,8 @@ possibilities to make their online payments. For example: .. seealso:: - :doc:`quote_template` - - :doc:`../../ecommerce` - - :doc:`../../ecommerce/shopper_experience/paypal` - - :doc:`../../ecommerce/shopper_experience/authorize` + - :doc:`../../general/payment_acquirers` + - :doc:`../../general/payment_acquirers/paypal` + - :doc:`../../general/payment_acquirers/authorize`