[ADD] payment_providers/paymob: add paymob configuration

task-4987887

closes #14835

Signed-off-by: Audrey Vandromme (auva) <[email protected]>

Author: auva-odoo

content/applications/finance/payment_providers.rst

@@ -19,6 +19,7 @@ Online payments
    payment_providers/mercado_pago
    payment_providers/mollie
    payment_providers/nuvei
+   payment_providers/paymob
    payment_providers/paypal
    payment_providers/razorpay
    payment_providers/stripe
@@ -121,6 +122,12 @@ Online payment providers
      -
      -
      -
+   * - :doc:`Paymob <payment_providers/paymob>`
+     - The provider's website
+     -
+     -
+     -
+     -
    * - :doc:`PayPal <payment_providers/paypal>`
      - The provider's website
      -
@@ -470,6 +477,7 @@ payments from other payments.
    - :doc:`payment_providers/mercado_pago`
    - :doc:`payment_providers/mollie`
    - :doc:`payment_providers/nuvei`
+   - :doc:`payment_providers/paymob`
    - :doc:`payment_providers/paypal`
    - :doc:`payment_providers/razorpay`
    - :doc:`payment_providers/stripe`

content/applications/finance/payment_providers/paymob.rst

@@ -0,0 +1,62 @@
+======
+Paymob
+======
+
+`Paymob <https://paymob.com/>`_ is an Egypt-based payment service provider operating in Egypt, Oman,
+Pakistan, Saudi Arabia, and the United Arab Emirates. It allows businesses to accept online payments
+through credit and debit cards, as well as several local payment methods.
+
+.. _payment_providers/paymob/configure_dashboard:
+
+Configuration on the Paymob dashboard
+=====================================
+
+#. Create a Paymob account if necessary and log into the Paymob dashboard:
+
+   - `Paymob dashboard for Egypt <https://accept.paymob.com/portal2/en/login>`_
+   - `Paymob dashboard for Oman <https://oman.paymob.com/portal2/en/login>`_
+   - `Paymob dashboard for Pakistan <https://pakistan.paymob.com/portal2/en/login>`_
+   - `Paymob dashboard for Saudi Arabia <https://ksa.paymob.com/portal2/en/login>`_
+   - `Paymob dashboard for the United Arab Emirates <https://uae.paymob.com/portal2/en/login>`_
+
+#. Check the account mode in the top left corner of the page. Use the :guilabel:`Test` mode to try
+   the integration without charging customers. Switch to :guilabel:`Live` mode once you are
+   ready to accept payments.
+#. Navigate to :menuselection:`Settings` in the left menu.
+#. In the :guilabel:`Account Info` section, copy the value of the :guilabel:`HMAC` field and save it
+   for :ref:`later <payment_providers/paymob/configure_odoo>`.
+#. Click :guilabel:`View` next to the :guilabel:`API Key`, :guilabel:`Secret Key`, and
+   :guilabel:`Public Key` fields to reveal each value. Copy each key and save it for
+   :ref:`later <payment_providers/paymob/configure_odoo>`.
+#. Navigate to :menuselection:`Developers --> Payment Integrations` in the left menu.
+#. Ensure that all required payment methods are listed in the payment integrations. If any
+   payment method is missing, contact Paymob support.
+
+.. _payment_providers/paymob/configure_odoo:
+
+Configuration on Odoo
+=====================
+
+#. :ref:`Navigate to the payment provider Paymob <payment_providers/add_new>` and change its state
+   to :guilabel:`Enabled` (or :guilabel:`Test Mode` if you are trying Paymob as a :ref:`test
+   <payment_providers/test-mode>`).
+#. In the :guilabel:`Credentials` tab, set the :guilabel:`Account Country` field to your company's
+   country.
+#. Fill in the :guilabel:`HMAC Key`, :guilabel:`API key`,
+   :guilabel:`Secret Key`, and :guilabel:`Public Key` fields with the information saved at the step
+   :ref:`payment_providers/paymob/configure_dashboard`.
+#. In the :guilabel:`Configuration` tab, click :guilabel:`Enable Payment Methods`, then
+   :ref:`activate the payment methods <payment_providers/payment_methods>` you want to offer.
+#. Return to the provider's form and click :guilabel:`Synchronize with Paymob`.
+
+   .. important::
+      - For a payment method to be available to customers, it must be activated in Odoo **and**
+        added to the :ref:`list of payment integrations on the Paymob dashboard
+        <payment_providers/paymob/configure_dashboard>`.
+      - If a payment method is added to the Paymob dashboard **after** synchronization, click
+        :guilabel:`Synchronize with Paymob` again to make it available in Odoo.
+
+#. Configure the remaining options as needed.
+
+.. seealso::
+   :doc:`../payment_providers`