|
2 | 2 | Razorpay |
3 | 3 | ======== |
4 | 4 |
|
5 | | -`Razorpay <https://razorpay.com/>`_ is an online payments provider established in India and |
6 | | -covering more than 100 payment methods. |
| 5 | +`Razorpay <https://razorpay.com/>`_ is an online payments provider established in India that |
| 6 | +supports more than 100 payment methods. |
| 7 | + |
| 8 | +.. _payment_providers/razorpay/oauth-connection: |
| 9 | + |
| 10 | +Create a Razorpay account with Odoo (Indian companies only) |
| 11 | +=========================================================== |
| 12 | + |
| 13 | +.. note:: |
| 14 | + - This method is only available for Indian companies. |
| 15 | + - This flow does not support the :ref:`test mode <payment_providers/test-mode>`. |
| 16 | + |
| 17 | +#. :ref:`Navigate to the Razorpay payment provider <payment_providers/supported_providers>` and |
| 18 | + click :guilabel:`Connect`. |
| 19 | +#. Go through the account creation process and enter the verification codes when prompted. |
| 20 | + |
| 21 | + .. tip:: |
| 22 | + If you already have a Razorpay account, enter your Razorpay credentials, select the account |
| 23 | + you want to link to your Odoo database (if applicable), then click :guilabel:`Continue`. |
| 24 | + |
| 25 | +#. At the end of the process, click :guilabel:`Authorize`. If all required information |
| 26 | + has been submitted, you are then redirected to Odoo, and the payment provider is |
| 27 | + :guilabel:`Enabled`. |
| 28 | + |
| 29 | +.. _payment_providers/razorpay/manual-connection: |
| 30 | + |
| 31 | +Manual credentials and webhook input |
| 32 | +==================================== |
7 | 33 |
|
8 | 34 | .. _payment_providers/razorpay/configure_dashboard: |
9 | 35 |
|
10 | | -Configuration on Razorpay Dashboard |
11 | | -=================================== |
| 36 | +Razorpay configuration |
| 37 | +---------------------- |
12 | 38 |
|
13 | | -#. Log into `Razorpay Dashboard <https://dashboard.razorpay.com/>`_ and go to |
14 | | - :menuselection:`Settings --> API Keys`. Generate the new keys and copy the values of the |
15 | | - :guilabel:`Key Id` and :guilabel:`Secret Key` fields and save them for later. |
16 | | -#. | Go to :menuselection:`Settings --> Webhooks`, click on :guilabel:`Create New Webhook`, |
17 | | - and enter your Odoo database URL followed by `/payment/razorpay/webhook` in |
18 | | - the :guilabel:`Webhook URL` text field. |
| 39 | +#. `Create a Razorpay account <https://accounts.razorpay.com/>`_ if necessary and log into the |
| 40 | + `Razorpay Dashboard <https://dashboard.razorpay.com/>`_. |
| 41 | +#. Go to the :guilabel:`Payments` tab at the top of the page. |
| 42 | +#. Toggle the :guilabel:`Test Mode` switch in the left menu to try the integration without |
| 43 | + charging customers. Toggle it off once you are ready to accept real payments. |
| 44 | +#. Click :guilabel:`Account & Settings` in the left menu, then, under :guilabel:`Website and app |
| 45 | + settings`, select `API Keys <https://dashboard.razorpay.com/app/website-app-settings/api-keys>`_. |
| 46 | +#. Copy the values of the :guilabel:`Key Id` and :guilabel:`Secret Key` fields and save them for |
| 47 | + later. |
| 48 | +#. Click :guilabel:`Account & Settings` in the left menu, then, under :guilabel:`Website and app |
| 49 | + settings`, select `Webhooks <https://dashboard.razorpay.com/app/website-app-settings/webhooks>`_. |
| 50 | +#. | Click :guilabel:`Add New Webhook`, then enter your Odoo database URL followed by |
| 51 | + `/payment/razorpay/webhook` in the :guilabel:`Webhook URL` field. |
19 | 52 | | For example: `https://example.odoo.com/payment/razorpay/webhook`. |
20 | 53 | #. Fill the :guilabel:`Secret` field with a password of your choice and save it for later. |
21 | | -#. Make sure the :guilabel:`payment.authorized`, :guilabel:`payment.captured`, |
22 | | - :guilabel:`payment.failed`, :guilabel:`refund.failed` and :guilabel:`refund.processed` |
23 | | - checkboxes are ticked. |
24 | | -#. Click on :guilabel:`Create Webhook` to finalize the configuration. |
| 54 | +#. Enable the following events: :guilabel:`payment.authorized`, :guilabel:`payment.captured`, |
| 55 | + :guilabel:`payment.failed`, :guilabel:`refund.failed`, and :guilabel:`refund.processed`. |
| 56 | +#. Click :guilabel:`Create Webhook` to finalize the configuration. |
25 | 57 |
|
26 | 58 | .. _payment_providers/razorpay/recurring_payments: |
27 | 59 |
|
28 | 60 | .. important:: |
29 | | - The :guilabel:`Recurring payments` feature must |
30 | | - be activated if you want to make recurring payments. |
31 | | - Send a request to the `Razorpay Support team <https://razorpay.com/support/#request>`_ to |
32 | | - enable recurring payments. |
| 61 | + The `Recurring payments <https://razorpay.com/docs/payments/recurring-payments/>`_ feature must |
| 62 | + be activated to accept recurring payments. To enable this feature, submit a request to the |
| 63 | + `Razorpay Support team <https://razorpay.com/support/#request>`_. |
33 | 64 |
|
34 | 65 | .. _payment_providers/razorpay/configure_odoo: |
35 | 66 |
|
36 | | -Configuration on Odoo |
37 | | -===================== |
| 67 | +Odoo configuration |
| 68 | +------------------ |
38 | 69 |
|
39 | | -#. :ref:`Navigate to the payment provider Razorpay <payment_providers/add_new>` and change its |
40 | | - state to :guilabel:`Enabled`. |
| 70 | +#. Activate :ref:`developer mode <developer-mode>`. |
| 71 | +#. :ref:`Navigate to the Razorpay payment provider <payment_providers/add_new>`. |
41 | 72 | #. In the :guilabel:`Credentials` tab, fill the :guilabel:`Key Id`, :guilabel:`Key Secret`, and |
42 | | - :guilabel:`Webhook Secret` with the values you saved at the step |
| 73 | + :guilabel:`Webhook Secret` with the values you saved during |
43 | 74 | :ref:`payment_providers/razorpay/configure_dashboard`. |
44 | | -#. Configure the rest of the options to your liking. |
| 75 | +#. Configure the remaining options as needed. |
| 76 | +#. Set the :guilabel:`State` field to :guilabel:`Enabled` (or :guilabel:`Test Mode` if you are |
| 77 | + trying Razorpay as a :ref:`test <payment_providers/test-mode>`). |
45 | 78 |
|
46 | 79 | .. important:: |
47 | | - If you configure Odoo to capture amounts manually: |
| 80 | + If you configure Odoo to :ref:`capture amounts manually <payment_providers/manual_capture>`: |
48 | 81 |
|
49 | | - - Be aware that the **manual voiding** of a transaction is not supported by Razorpay. |
50 | | - - After **five days**, if the transaction hasn't been captured yet, it'll automatically be |
51 | | - **voided**. |
| 82 | + - **Manual voiding** of a transaction is not supported by Razorpay. |
| 83 | + - Transactions that remain uncaptured for more than **five days** are automatically **voided**. |
52 | 84 |
|
53 | 85 | .. seealso:: |
54 | | - - :doc:`../payment_providers` |
| 86 | + :doc:`../payment_providers` |
0 commit comments