|
| 1 | +========= |
| 2 | +Worldline |
| 3 | +========= |
| 4 | + |
| 5 | +`Worldline <https://worldline.com/>`_ is a France-based company and the world's fourth largest |
| 6 | +payment provider. |
| 7 | + |
| 8 | +Settings in Worldline |
| 9 | +===================== |
| 10 | + |
| 11 | +.. _worldline/API-user: |
| 12 | + |
| 13 | +Create an API user |
| 14 | +------------------ |
| 15 | + |
| 16 | +It is recommended to set up an **API user** to create transactions from Odoo to ensure that your |
| 17 | +Worldline configuration remains safe even if credentials are compromised. Additionally, API users do |
| 18 | +not require frequent password updates like regular accounts. |
| 19 | + |
| 20 | +To create an **API user**, proceed as follows: |
| 21 | + |
| 22 | +#. Log into your `Worldline Merchant Portal <https://merchant-portal.preprod.worldline-solutions.com/dashboard>`_, |
| 23 | + click the :icon:`fa-th` (:guilabel:`menu`) icon, and select :guilabel:`Back Office`. |
| 24 | +#. Go to :menuselection:`Configuration --> Users` and click on :guilabel:`New User`. |
| 25 | +#. Configure the following fields: |
| 26 | + |
| 27 | + #. Specify a :guilabel:`UserID`, :guilabel:`User's name`, :guilabel:`E-mail address`, and |
| 28 | + :guilabel:`Timezone` of your choice. |
| 29 | + #. Set the :guilabel:`Profile` field to :guilabel:`Admin`. |
| 30 | + #. Enable :guilabel:`Special user for API`. |
| 31 | + |
| 32 | +.. tip:: |
| 33 | + If you have already set up a user, make sure it is activated without any error. |
| 34 | + |
| 35 | +.. _worldline/set-up: |
| 36 | + |
| 37 | +Set up Worldline for Odoo |
| 38 | +------------------------- |
| 39 | + |
| 40 | +Worldline must now be configured to accept payments from Odoo. |
| 41 | + |
| 42 | +#. From your merchant portal, go to :menuselection:`Developer --> Payment API` and click on |
| 43 | + :guilabel:`Generate API key`. Copy the :guilabel:`API key ID` and the :guilabel:`Secret API key` |
| 44 | + and save them for :ref:`later <worldline/odoo-configuration>`. |
| 45 | +#. Go to :menuselection:`Developer --> Webhooks` and click on :guilabel:`Generate webhook keys`. |
| 46 | + Copy the :guilabel:`Webhook ID` and the associated :guilabel:`Secret webhook key` and |
| 47 | + save them for :ref:`later <worldline/odoo-configuration>`. |
| 48 | +#. | Click :guilabel:`Add webhook endpoint`, enter your Odoo database's URL followed by |
| 49 | + `/payment/worldline/webhook` in the :guilabel:`Endpoint url` field, and :guilabel:`Confirm`. |
| 50 | + | For example: `https://example.odoo.com/payment/worldline/webhook`. |
| 51 | +
|
| 52 | +.. _worldline/odoo-configuration: |
| 53 | + |
| 54 | +Settings in Odoo |
| 55 | +================ |
| 56 | + |
| 57 | +To set up Worldline in Odoo: |
| 58 | + |
| 59 | +#. :ref:`Navigate to the payment provider Worldline <payment_providers/add_new>`. |
| 60 | +#. In the :guilabel:`Credentials` tab, enter the :guilabel:`PSPID` of your Worldline account and |
| 61 | + fill in the :guilabel:`API Key`, :guilabel:`API Secret`, :guilabel:`Webhook Key`, and |
| 62 | + :guilabel:`Webhook Secret` with the values you saved at the step :ref:`Set up Worldline for |
| 63 | + Odoo <worldline/set-up>`. |
| 64 | +#. Configure the rest of the options to your liking. |
| 65 | +#. Set the :guilabel:`State` field to :guilabel:`Enabled`. |
| 66 | + |
| 67 | +.. seealso:: |
| 68 | + :doc:`../payment_providers` |
| 69 | + |
| 70 | +.. _worldline/ogone-migration: |
| 71 | + |
| 72 | +Migration from Ogone to Worldline |
| 73 | +================================= |
| 74 | + |
| 75 | +As of January 1, 2026, Worldline, the company behind the Ogone payment solution, no longer supports |
| 76 | +Ogone. Users of the :doc:`Ogone payment provider <ogone>` should migrate to Worldline. To do so, |
| 77 | +follow these steps: |
| 78 | + |
| 79 | +#. Log into the `Worldline Merchant Portal <https://merchant-portal.preprod.worldline-solutions.com/dashboard>`_ |
| 80 | + using your Ogone account credentials. |
| 81 | +#. Complete the :ref:`Worldline setup for Odoo <worldline/set-up>`. The existing API key and secret |
| 82 | + can be reused; however, **a new webhook key and secret must be regenerated**. |
| 83 | +#. For on-premise installations or databases managed by a partner, update the Odoo installation |
| 84 | + as described in the :doc:`/administration/on_premise/update` documentation, or by |
| 85 | + contacting your integrating partner. |
| 86 | +#. In Odoo, :ref:`install <general/install>` the :guilabel:`Payment Provider: Worldline` |
| 87 | + (`payment_worldline`) module. |
| 88 | +#. :ref:`Configure the Worldline payment provider <worldline/odoo-configuration>`. |
0 commit comments