diff --git a/content/applications/finance/payment_providers.rst b/content/applications/finance/payment_providers.rst index d73749f4b..01a7ce846 100644 --- a/content/applications/finance/payment_providers.rst +++ b/content/applications/finance/payment_providers.rst @@ -17,11 +17,10 @@ Online payments payment_providers/flutterwave payment_providers/mercado_pago payment_providers/mollie - payment_providers/ogone payment_providers/paypal payment_providers/razorpay - payment_providers/sips payment_providers/stripe + payment_providers/worldline payment_providers/xendit Odoo embeds several **payment providers** that allow your customers to pay online, on their @@ -126,18 +125,18 @@ Online payment providers - Full only - Full and partial - - * - :doc:`SIPS ` - - The provider's website - - - - - - - - * - :doc:`Stripe ` - Odoo - |V| - Full only - Full and partial - |V| + * - :doc:`Worldline ` + - The provider's website + - |V| + - + - + - * - :doc:`Xendit ` - The provider's website - @@ -457,11 +456,10 @@ other payments. - :doc:`payment_providers/demo` - :doc:`payment_providers/mercado_pago` - :doc:`payment_providers/mollie` - - :doc:`payment_providers/ogone` - :doc:`payment_providers/paypal` - :doc:`payment_providers/razorpay` - - :doc:`payment_providers/sips` - :doc:`payment_providers/stripe` + - :doc:`payment_providers/worldline` - :doc:`payment_providers/xendit` - :doc:`../websites/ecommerce/checkout_payment_shipping/payments` - :doc:`accounting/bank` diff --git a/content/applications/finance/payment_providers/ogone.rst b/content/applications/finance/payment_providers/ogone.rst deleted file mode 100644 index aff240a7f..000000000 --- a/content/applications/finance/payment_providers/ogone.rst +++ /dev/null @@ -1,107 +0,0 @@ -===== -Ogone -===== - -`Ogone `_, also known as **Ingenico Payment Services** is a France-based -company that provides the technology involved in secure electronic transactions. - -.. seealso:: - - :ref:`payment_providers/add_new` - - `Ogone's documentation `_. - -.. warning:: - The provider Ogone is deprecated. It is recommended to use :doc:`stripe` instead. - -Settings in Ogone -================= - -Create an API user ------------------- - -Log into your Ogone account and head to the :guilabel:`Configuration` tab. - -You need to create an **API user** to be used in the creation of transactions from Odoo. While you -can use your main account to do so, using an **API user** ensures that if the credentials used in -Odoo are leaked, no access to your Ogone configuration is possible. Additionally, passwords for -**API users** do not need to be updated regularly, unlike normal users. - -To create an **API user**, go to :menuselection:`Configuration --> Users` and click on -:guilabel:`New User`. The following fields must be configured: - -.. _ogone/ogone: - -- :guilabel:`UserID`: you can choose anything you want. -- :guilabel:`User's Name, E-mail and Timezone`: you can enter the information you want. -- :guilabel:`Profile`: should be set to :guilabel:`Admin`. -- :guilabel:`Special user for API`: should be checked. - -After the creation of the user, you are required to generate a password. Save the password and -**UserID**, as they will be required later on during the setup. - -.. tip:: - If you already have an user set up, make sure it is activated without any error. If not, simply - click the :guilabel:`Activate(Errors)` button to reset the user. - -Set up Ogone for Odoo ---------------------- - -Ogone must now be configured to accept payments from Odoo. Head to :menuselection:`Configuration --> -Technical Information --> Global Security Parameters`, select :guilabel:`SHA-512` as -:guilabel:`Hash Algorithm` and :guilabel:`UTF-8` as :guilabel:`character encoding`. Then, go to the -:guilabel:`Data and Origin verification` tab of the same page and leave the URL field of the -:guilabel:`e-Commerce and Alias Gateway` section blank. - -.. tip:: - If you need to use another algorithm, such as `sha-1` or `sha-256`, within Odoo, activate the - :ref:`developer mode ` and go to the **Payment Providers** page in - :menuselection:`Accounting --> Configuration --> Payment Providers`. Click on :guilabel:`Ogone`, - and in the :guilabel:`Credentials` tab, select the algorithm you wish to use in the - :guilabel:`Hash function` field. - -You are now required to generate **SHA-IN** passphrases. **SHA-IN** and **SHA-OUT** passphrases are -used to digitally sign the transaction requests and responses between Odoo and Ogone. By using these -secret passphrases and the `sha-1` algorithm, both systems can ensure that the information they -receive from the other was not altered or tampered with. - -Enter the same **SHA-IN** passphrase in both :guilabel:`Checks for e-Commerce & Alias Gateway` and -:guilabel:`Checks for DirectLink and Batch (Automatic)`. You can leave the IP address field blank. - -Your **SHA-IN** and **SHA-OUT** passphrases should be different, and between 16 and 32 characters -long. Make sure to use the same **SHA-IN** and **SHA-OUT** passphrases throughout the entire Ogone -configuration, as Odoo only allows a single **SHA-IN** and single **SHA-OUT** passphrase. - -In order to retrieve the **SHA-OUT** key, log into your Ogone account, go to -:menuselection:`Configuration --> Technical Information --> Transaction feedback --> All -transaction submission modes`, and get or generate your **API Key** and **Client Key**. Be careful -to copy your API key as you’ll not be allowed to get it later without generating a new one. - -When done, head to :menuselection:`Configuration --> Technical Information --> Transaction Feedback` -and check the following options: - -- The :guilabel:`URL` fields for :guilabel:`HTTP redirection in the browser` can be left empty, as - Odoo will specify these URLs for every transaction request. -- :guilabel:`I would like to receive transaction feedback parameters on the redirection URLs`: - should be checked. -- :guilabel:`Direct HTTP server-to-server request`: should to be set to `Online but switch to a - deferred request when the online request fails`. -- Both **URL** fields should contain the same following URL, with `` replaced by your - database: `https:///payment/ogone/return`. - -- :guilabel:`Dynamic eCommerce Parameters` should contain the following values: `ALIAS`, `AMOUNT`, - `CARDNO`, `CN`, `CURRENCY`, `IP`, `NCERROR` `ORDERID`, `PAYID`, `PM`, `STATUS`, `TRXDATE`. Other - parameters can be included (if you have another integration with Ogone that requires them), but - are not advised. -- In the :guilabel:`All transaction submission modes` section, fill out **SHA-OUT** passphrase and - disable `HTTP request for status change`. - -To allow your customers to save their credit card credentials for future use, head to -:menuselection:`Configuration --> Alias --> My alias information`. From this tab, you can configure -how the user can have its card details saved, for how long the information is saved, if a checkbox -to save the card information should be displayed, etc. - -Settings in Odoo -================ - -To set up Ogone in Odoo, head to :menuselection:`Accounting --> Configuration --> Payment Providers` -and open the Ogone provider. In the :guilabel:`Credentials` tab, enter the **PSPID** of your Ogone -account, and fill out the other fields as configured in your :ref:`Ogone portal `. diff --git a/content/applications/finance/payment_providers/sips.rst b/content/applications/finance/payment_providers/sips.rst deleted file mode 100644 index 982fe3110..000000000 --- a/content/applications/finance/payment_providers/sips.rst +++ /dev/null @@ -1,32 +0,0 @@ -==== -SIPS -==== - -`SIPS `_ is an online payments solution from the multinational -Worldline. - -Configuration -============= - -.. seealso:: - - :ref:`payment_providers/add_new` - -Credentials tab ---------------- - -Odoo needs your **API Credentials** to connect with your SIPS account, which comprise: - -- **Merchant ID**: The ID solely used to identify the merchant account with SIPS. -- **Secret Key**: The key to sign the merchant account with SIPS. -- **Secret Key Version**: The version of the key, pre-filled. -- **Interface Version**: Pre-filled, don't change it. - -You can copy your credentials from your SIPS environment info documentation, in the section -**PROD**, and paste them in the related fields under the **Credentials** tab. - -.. important:: - If you are trying SIPS as a test, with the *TEST* credentials, change the **State** to *Test - Mode*. We recommend doing this on a test Odoo database, rather than on your main database. - -.. seealso:: - - :doc:`../payment_providers` diff --git a/content/applications/finance/payment_providers/worldline.rst b/content/applications/finance/payment_providers/worldline.rst new file mode 100644 index 000000000..9ab8bbb41 --- /dev/null +++ b/content/applications/finance/payment_providers/worldline.rst @@ -0,0 +1,68 @@ +========= +Worldline +========= + +`Worldline `_ is a France-based company and the world's fourth largest +payment provider. + +Settings in Worldline +===================== + +.. _worldline/API-user: + +Create an API user +------------------ + +It is recommended to set up an **API user** to create transactions from Odoo to ensure that your +Worldline configuration remains safe even if credentials are compromised. Additionally, API users do +not require frequent password updates like regular accounts. + +To create an **API user**, proceed as follows: + +#. Log into your `Worldline Merchant Portal `_, + click the :icon:`fa-th` (:guilabel:`menu`) icon, and select :guilabel:`Back Office`. +#. Go to :menuselection:`Configuration --> Users` and click on :guilabel:`New User`. +#. Configure the following fields: + + #. Specify a :guilabel:`UserID`, :guilabel:`User's name`, :guilabel:`E-mail address`, and + :guilabel:`Timezone` of your choice. + #. Set the :guilabel:`Profile` field to :guilabel:`Admin`. + #. Enable :guilabel:`Special user for API`. + +.. tip:: + If you have already set up a user, make sure it is activated without any error. + +.. _worldline/set-up: + +Set up Worldline for Odoo +------------------------- + +Worldline must now be configured to accept payments from Odoo. + +#. From your merchant portal, go to :menuselection:`Developer --> Payment API` and click on + :guilabel:`Generate API key`. Copy the :guilabel:`API key ID` and the :guilabel:`Secret API key` + and save them for :ref:`later `. +#. Go to :menuselection:`Developer --> Webhooks` and click on :guilabel:`Generate webhook keys`. + Copy the :guilabel:`Webhook ID` and the associated :guilabel:`Secret webhook key` and + save them for :ref:`later `. +#. | Click :guilabel:`Add webhook endpoint`, enter your Odoo database's URL followed by + `/payment/worldline/webhook` in the :guilabel:`Endpoint url` field, and :guilabel:`Confirm`. + | For example: `https://example.odoo.com/payment/worldline/webhook`. + +.. _wordline/odoo-configuration: + +Settings in Odoo +================ + +To set up Worldline in Odoo: + +#. :ref:`Navigate to the payment provider Worldline ` and change its + state to :guilabel:`Enabled`. +#. In the :guilabel:`Credentials` tab, enter the :guilabel:`PSPID` of your Worldline account and + fill in the :guilabel:`API Key`, :guilabel:`API Secret`, :guilabel:`Webhook Key`, and + :guilabel:`Webhook Secret` with the values you saved at the step :ref:`Set up Worldline for + Odoo `. +#. Configure the rest of the options to your liking. + +.. seealso:: + :doc:`../payment_providers` diff --git a/redirects/18.0.txt b/redirects/18.0.txt new file mode 100644 index 000000000..5a05e98cb --- /dev/null +++ b/redirects/18.0.txt @@ -0,0 +1,4 @@ +# applications/finance + +applications/finance/payment_providers/ogone.rst applications/finance/payment_providers/worldline.rst +applications/finance/payment_providers/sips.rst applications/finance/payment_providers/worldline.rst