diff --git a/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst b/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst index 3c1064c62..cd244c9aa 100644 --- a/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst +++ b/content/applications/finance/accounting/receivables/customer_payments/online_payment.rst @@ -42,4 +42,4 @@ They can choose which Payment Acquirer to use by clicking on *Pay Now*. .. seealso:: - - :doc:`/applications/general/payment_acquirers/payment_acquirers` + - :doc:`/applications/general/payment_acquirers` diff --git a/content/applications/general/payment_acquirers.rst b/content/applications/general/payment_acquirers.rst index 1557e43a9..6c75e33ca 100644 --- a/content/applications/general/payment_acquirers.rst +++ b/content/applications/general/payment_acquirers.rst @@ -1,12 +1,239 @@ -================= -Payment Acquirers -================= +:show-content: + +================================================ +Payment Acquirers (Credit Cards, Online Payment) +================================================ .. toctree:: :titlesonly: - payment_acquirers/payment_acquirers payment_acquirers/wire_transfer payment_acquirers/authorize payment_acquirers/paypal payment_acquirers/stripe + +Odoo embeds several **payment acquirers** that allow your customers to pay on their *Customer +Portals* or your *eCommerce website*. They can pay Sales Orders, invoices, or subscriptions with +recurring payments with their favorite payment methods such as **Credit Cards**. + +Offering several payment methods increases the chances of getting paid in time, or even immediately, +as you make it more convenient for your customers to pay with the payment method they prefer and +trust. + +.. image:: payment_acquirers/online-payment.png + :align: center + :alt: Pay online in the customer portal and select which payment acquirer to use. + +.. note:: + Odoo apps delegate the handling of sensitive information to the certified payment acquirer so + that you don't ever have to worry about PCI compliance. + + This means that no sensitive information (such as credit card numbers or credentials) is stored + on Odoo servers or Odoo databases hosted elsewhere. Instead, Odoo apps use a unique reference + number to the data stored safely in the payment acquirers' systems. + +.. _payment_acquirers/acquirers: + +Payment Acquirers +================= + +From an accounting perspective, we can distinguish two types of payment acquirers: the payments that +go directly on the bank account and follow the usual reconciliation workflow, and the payment +acquirers that are third-party services and require you to follow another accounting workflow. + +.. _payment_acquirers/bank_payments: + +Bank Payments +------------- + +- | :doc:`Wire Transfer ` + | 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 <../finance/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 + <../finance/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:: 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:`../finance/accounting/receivables/customer_payments/recording` + - :doc:`payment_acquirers/wire_transfer` + - :doc:`payment_acquirers/authorize` + - :doc:`payment_acquirers/paypal` \ No newline at end of file diff --git a/content/applications/general/payment_acquirers/media/payment-acquirers-activation.png b/content/applications/general/payment_acquirers/activation.png similarity index 100% rename from content/applications/general/payment_acquirers/media/payment-acquirers-activation.png rename to content/applications/general/payment_acquirers/activation.png diff --git a/content/applications/general/payment_acquirers/authorize.rst b/content/applications/general/payment_acquirers/authorize.rst index 5437b0c3e..cec04d3da 100644 --- a/content/applications/general/payment_acquirers/authorize.rst +++ b/content/applications/general/payment_acquirers/authorize.rst @@ -10,7 +10,7 @@ provider, allowing businesses to accept **credit cards**. :alt: Authorize.Net logo This Payment Acquirer offers additional options that are not available for other :doc:`Payment -Acquirers `, such as the ability to process your customer's payment after +Acquirers <../payment_acquirers>`, such as the ability to process your customer's payment after delivery. Authorize.Net account @@ -47,7 +47,7 @@ Configuration --> Payment Acquirers`, open **Authorize.Net**, and change the **S Don't forget to click on *Save* once you've set everything up. .. note:: - Please refer to the :doc:`Payment Acquirers documentation ` to read how to + Please refer to the :doc:`Payment Acquirers documentation <../payment_acquirers>` to read how to configure this payment acquirer. Credentials @@ -113,5 +113,5 @@ order is canceled, you can click on *Void Transaction* to unlock the funds from .. seealso:: - `Authorize.Net: Getting Started Guide `__ - - :doc:`payment_acquirers` + - :doc:`../payment_acquirers` - :doc:`../../websites/ecommerce/shopper_experience/payment_acquirer` diff --git a/content/applications/general/payment_acquirers/media/payment-acquirers-online-payment.png b/content/applications/general/payment_acquirers/online-payment.png similarity index 100% rename from content/applications/general/payment_acquirers/media/payment-acquirers-online-payment.png rename to content/applications/general/payment_acquirers/online-payment.png diff --git a/content/applications/general/payment_acquirers/payment_acquirers.rst b/content/applications/general/payment_acquirers/payment_acquirers.rst deleted file mode 100644 index 475edd18b..000000000 --- a/content/applications/general/payment_acquirers/payment_acquirers.rst +++ /dev/null @@ -1,226 +0,0 @@ -================================================ -Payment Acquirers (Credit Cards, Online Payment) -================================================ - -Odoo embeds several **payment methods** that allow your customers to pay on their *Customer Portals* -or your *eCommerce website*. They can pay Sales Orders, invoices, or subscriptions with recurring -payments with their favorite payment acquirers, including **online payment providers** that accept -**Credit Cards**. - -Having several payment methods increases the chances of getting paid in time, or even immediately, -as you make it more convenient for your customers to pay with the payment method they prefer and -trust. - -.. image:: media/payment-acquirers-online-payment.png - :align: center - :alt: Pay online in the customer portal and select which payment acquirer to use. - -.. important:: - Odoo does not keep Credit Card numbers or credentials on its servers, nor is it stored on Odoo - databases hosted elsewhere. Instead, Odoo apps use a unique reference to the data stored in the - payment acquirers' systems, where the information is safely stored. This reference is useless - without your credentials for the payment acquirer. - -.. _payment_acquirers/acquirers: - -Payment Acquirers -================= - -From an accounting perspective, we can distinguish two types of payment acquirers: the payments that -go directly on the bank account and follow the usual reconciliation workflow, and the payment -acquirers that are third-party services and require you to follow another accounting workflow. - -.. _payment_acquirers/bank_payments: - -Bank Payments -------------- - -- | :doc:`Wire Transfer ` - | 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 <../../finance/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 - <../../finance/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:`../../finance/accounting/receivables/customer_payments/recording` - - :doc:`wire_transfer` - - :doc:`authorize` - - :doc:`paypal` \ No newline at end of file diff --git a/content/applications/general/payment_acquirers/paypal.rst b/content/applications/general/payment_acquirers/paypal.rst index cade12d69..ee0ae614a 100644 --- a/content/applications/general/payment_acquirers/paypal.rst +++ b/content/applications/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_acquirers` + - :doc:`../payment_acquirers` - :doc:`../../websites/ecommerce/shopper_experience/payment_acquirer` diff --git a/content/applications/marketing/events/overview/tickets.rst b/content/applications/marketing/events/overview/tickets.rst index 504fb84c3..43d827d08 100644 --- a/content/applications/marketing/events/overview/tickets.rst +++ b/content/applications/marketing/events/overview/tickets.rst @@ -50,4 +50,4 @@ among the payment methods you chose to have available. :alt: View of website transaction for Odoo Events .. seealso:: - - :doc:`/applications/general/payment_acquirers/payment_acquirers` + - :doc:`/applications/general/payment_acquirers` diff --git a/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst b/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst index d7cc5b7e2..fdd9e7fca 100644 --- a/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst +++ b/content/applications/websites/ecommerce/shopper_experience/payment_acquirer.rst @@ -56,7 +56,7 @@ orders straight on. Select your **bank account** if you get paid immediately on your bank account. If you don't you can create a specific journal for the payment acquirer (type = Bank). That way, you can track online payments in an intermediary account of your books until you get paid into your bank - account (see :doc:`/applications/general/payment_acquirers/payment_acquirers`). + account (see :doc:`/applications/general/payment_acquirers`). Capture the payment after the delivery diff --git a/redirects.txt b/redirects.txt index 6bc041f4f..6d90944ab 100644 --- a/redirects.txt +++ b/redirects.txt @@ -199,5 +199,6 @@ general/odoo_basics/add_user.rst applications/general/odoo_basics/users.rst applications/general/in_app_purchase/in_app_purchase.rst applications/general/in_app_purchase.rst # in_app_purchase/in_app_purchase -> in_app_purchase applications/general/tags/take_tags.rst applications/general/tags.rst # tags/take_tags -> tags applications/general/multi_companies/manage_multi_companies.rst applications/general/multi_companies.rst # multi_companies/manage_multi_companies -> multi_companies +applications/general/payment_acquirers/payment_acquirers.rst applications/general/payment_acquirers.rst # payment_acquirers/payment_acquirers -> payment_acquirers applications/finance/sign/overview/signature_validity.rst applications/finance/sign.rst #sign/overview/signature_validity -> sign/*