From b1a958006fed2b498062a6d2fbcaa9e7ddd56381 Mon Sep 17 00:00:00 2001 From: "Tom Aarab (toaa)" Date: Fri, 27 May 2022 14:41:10 +0000 Subject: [PATCH] [IMP] payment providers: ingenico documentation updated This is a new documentation for the Ingenico payment provider, as support received a lot of tickets from customers having issues setting-up ingenico properly. task - 2834329 closes odoo/documentation#2527 X-original-commit: b064a7ed6b20bdae67eb0dd013ce5a5aab305fbb Signed-off-by: Antoine Vandevenne (anv) Signed-off-by: Aarab Tom (toaa) --- .../finance/payment_acquirers/ogone.rst | 141 +++++++++--------- .../ogone/ogone_new_user.png | Bin 3985 -> 0 bytes 2 files changed, 73 insertions(+), 68 deletions(-) delete mode 100644 content/applications/finance/payment_acquirers/ogone/ogone_new_user.png diff --git a/content/applications/finance/payment_acquirers/ogone.rst b/content/applications/finance/payment_acquirers/ogone.rst index b15d680bd..67e9bc0b0 100644 --- a/content/applications/finance/payment_acquirers/ogone.rst +++ b/content/applications/finance/payment_acquirers/ogone.rst @@ -5,95 +5,100 @@ Ogone `Ogone `_, also known as **Ingenico Payment Services** is a France-based company that provides the technology involved in secure electronic transactions. -Configuration on Odoo -===================== - .. seealso:: - :ref:`payment_acquirers/add_new` + - `Ogone's documentation `_. -Credentials tab ---------------- +Settings in Ogone +================= -Odoo needs your **API Credentials** to connect with your Ogone account, which comprise: +Create an API user +------------------ -- **PSPID**: The ID solely used to identify the account with Ogone. You chose it when you opened - your account. -- :ref:`API User ID `: The ID solely used to identify the user with Ogone. -- :ref:`API User Password `: Value used to identify the user with Ogone. -- :ref:`SHA Key IN `: Key used in the signature Odoo send to Ogone. -- :ref:`SHA Key OUT `: Key used in the signature Ogone send to Odoo. +Log into your Ogone account and head to the :guilabel:`Configuration` tab. -You can copy your credentials from your Ogone account, and paste them in the related fields under -the **Credentials** 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. -.. _ogone/api_user: +To create an **API user**, go to :menuselection:`Configuration --> Users` and click on +:guilabel:`New User`. The following fields must be configured: -API User ID and Password -~~~~~~~~~~~~~~~~~~~~~~~~ +.. _ogone/ogone: -If you already created a user and have both its ID and password, just copy them. You can also -generate a new password from :menuselection:`Configuration --> Users --> Your chosen user --> change -password`. +- :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. -If you don't have a user, create one by going to :menuselection:`Configuration --> Users --> -New User`. Set your **User ID** to get your **password** when you save your new user. +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. -.. image:: ogone/ogone_new_user.png - :align: center - :alt: Get your password when you save the new user. +.. 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. -.. _ogone/sha_key_in: +Set up Ogone for Odoo +--------------------- -SHA Key IN -~~~~~~~~~~ +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. -In order to retrieve the SHA Key IN, log into your ogone account, go to -:menuselection:`Configuration --> Technical Information --> Data and origin verification --> -Checks for e-Commerce & Alias Gateway`, and retrieve **SHA Key IN**. +.. 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 Acquirers** page in + :menuselection:`Accounting --> Configuration --> Payment Acquirers`. Click on :guilabel:`Ogone`, + and in the :guilabel:`Credentials` tab, select the algorithm you wish to use in the + :guilabel:`Hash function` field. -.. _ogone/sha_key_out: +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. -SHA Key OUT -~~~~~~~~~~~ +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. -In order to retrieve the SHA Key OUT, 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. +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. -.. important:: - If you are trying Ogone as a test, with the Test Account, change the **State** to *Test Mode*. We - recommend doing this on a test Odoo database, rather than on your main database. +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. -Hash function -~~~~~~~~~~~~~ +When done, head to :menuselection:`Configuration --> Technical Information --> Transaction Feedback` +and check the following options: -The hash function used to communicate with Ogone. It should be similar to the one set on Ogone. +- 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`. -For new Odoo database, it's set to 'SHA512' by default which is Ogone default. -If you upgrade from an older Odoo version, it will be set to Odoo's old default ('SHA1'). +- :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`. -This setting is only available in developer mode. +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 +================ -Configuration on Ogone -====================== - -Now that Odoo can communicate with Ogone, we need to make sure that Ogone can send information to -your database. - -To do so, log into your Ogone account and go to :menuselection:`Configuration --> Technical -Information --> Transaction feedback --> Direct HTTP server-to-server request`. - -Then, fill the form with the following data: - -- In the **Timing of the request**, select *Online but switch to a deferred request when the online - requests fail*. -- | Enter your Odoo databases URL in both **URLs** followed by ``/payment/ogone/return``. - | For example: ``https://yourcompany.odoo.com/payment/ogone/return`` -- Select *POST* for the **Request Method**. - -Save, and you are ready to go! - -.. seealso:: - - :doc:`../payment_acquirers` +To set up Ogone in Odoo, head to :menuselection:`Accounting --> Configuration --> Payment Acquirers` +and open the Ogone acquirer. 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 `. \ No newline at end of file diff --git a/content/applications/finance/payment_acquirers/ogone/ogone_new_user.png b/content/applications/finance/payment_acquirers/ogone/ogone_new_user.png deleted file mode 100644 index 69e97504ecaa5f4307aa6ee0c0f12bfae606d6ca..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3985 zcmY+Hc`(%fAII0#N^&H(tVj~&Nbc56DQD!0h?V=kVpmv4ZG;?=D#IRqX!Q^uZ`@e+;)j4gf&!6t!Tq;3swMCv|<}aC!ZZID0U;akw(GKQVjo zWA5O`+97f6aB2QvYW0w?a4@|>!7m(OS160iltltCyF{7812c;NZizBaq%44pB5^nz zvcny87yh!_7j(m=68FA#HW#Gi2a@$HolbkxAN+nO=Hq0NgRi}f=abaIaDLmkyfM@a z=@_IQbVet{%G0%M@t8)*&Cb^?-p96nu3)i0`77!8L-=D@F(G#7*vBDU_7xqTMDcSp z0ZGD^_F7H+vu*w3L;EH}JE@B!5teU;9ywWAr%!ihyWrP9;<4ypf2&6?@_Py$V6O_D z3On&6vUP|77dsa^{Ry6ge_(6;7KgnlC2x^hR}kxB8x)FPSq%KV73Ab*6;>M+Y0qI2 zzO-AOI!YM><_1gL7MIcPmFxaqj+N05HQkbHH;%hEjz=5a88v*$wr0nE9)}Lh=fX_~ zfH}fJUmlj48En5Wn$?hGHBuG0I9-Elh64wq+$JAwv%X-O;+H66G2=LwxX6Uar)F^_ zG1bi#s3(*0Q2g2ko;VQW>EY)0zL@}Mrtp|YcNkrvAhQA4VI#$AD=zD)u;Zg`~wpROgPXc?7P50KmC%@US2YNr8UviGBB zWKH!{O`M#lZ|c+Ud&9uNqSA}6#zvVv;yRc_$~0f+ zV%Py8Xd4>9AEd5U^1BI$4U<=+Bs7x6g`kYR;2jMi=u1}G9Su0!OV%aFiBHEi-W=J3){rCOT*trW^W2H9 z&vkc1+Yxt^zXJeBbhSvs+gShP&3a;5Fxwncbg_xS5%YO3955lBD$#op1fp%{$-}TJ zYR7#`Rvsvn9)5{JK1!+)l!n9UH?gkY_bx%$|M^uJkthOz+MNAK(}Tf8d|%raIG|+w z^DG3!3<*yO#}gakZX`>^OWjeG)J;^2=A#Tc9BOl(gj&`kqX)iS_+#&Ci9kKHT&-od z2gvk>R9u}(>4A+}2eJ5$Czg*Q+=!c)c>3qB2w7Ue(#QqEa-kC(+8|c}1w&O8Xqh2! z5S6i0x$4hVL>LPNKYM`}4zthjmf7u46Hdw=*JV~nQy^2{n3E|=>^*;>Fr5TLd;OlV zu7Slz{w|^e%@wC=c@7&>);_uX(DUkX8 zw1WBdZq)CZRe_v>?rg@(WC8<}sj$t>>o32aIa0JFr7uKkt@tvcfSdcOwbJAy7fgOt zCkWbkPf zPZP_^B8}93e2-+XdtjugZ0rw@bv*aL-pMDmFGGZziJo-re!+E`tMccC@klzTBq{yL zZiUGY7eUg5n78YtrF9M^>9JMqkOJ`v-oSs`Ybhxv?04PEJ0L-&zmXVcw*>Z06`q<6- zcT`>OLaw}PaYCsaCf#Qsn}6MLLqx?g)c3+L^J7&d#cCrb1t11)HCnnQt{T!f(MP`-BV()gYmBPmV3JhPmS zXPn7ai#d%sv2l9#$u5EoXS|-TNfD@nPgMFq+S42{F zo+mAu8jt@mW~3^4Ylz7e?U2KB9T5!Ga?Fse&J3xm_bvN8bCe{@Rv4tEi^a1@#wIQliR0-A| z@L%5w7z9m2gO-4{T7A=$FeaR2prB`1$Q8{WHyQZ~Rb)f>6?;9{VZCkm_&`5Twp~L0FLkl`oPcteAEi z`jTaOcZVzU^p;G8S|2EWNc);v58uQ&V>ZX`IDL9NfRSH90zyz8s8>kXq7XEDi`W_T z-cx5mo!v{|j=J;EAhbzL2%`6j)nZ46IyXzDNFw-p$;lT4STHj@dUS$@1_tI*oF|{B z-*M_z%gc%FilBp%ZoPA#C`-`6^q0TUJ%@wnt2M>l6DK)GO6Q+z{Fcidm;G49EAA!- zOHOf}pE#~stS>cRbq0o@AKRR-a`80xz$5@CUEr_1MDFpE;>1*vj|yZE{Ng)Ct1%Td zJak*Kf97zYx%u$9@qj(&-CGx(O($|h#>_C!Yljc9uNjr4Rcy@U__Y=GW#JE`s4kLh z@hFGO`VU%S|F8!(`~btYl5f9Z)P7ddN*lQWQM_Trlp-YGpo4*(yJA77^`Q0WXhXP& zC9uwU0xG+8U;CZ@80isec8#7EX6{*5dVT99qcZPm^e1*X%xyoDtA?ssI>X(*A z4{zW1G%bT(O>#SlMNPc27Vf>RPc{i=_Ql4}g`)4Hb%_E)_Ou!4lW zP@j$a+?}7eLM3`UORLy<0IjIxgIPTHz>|)AYlz7i*3E28Ketzl!j*40y(rbaH18XZ zR_3UjXDhidC===Hx7_pIfO_|h_z0s4mL~0^{3mB|vvh%T2YO+Lyd>XeTWXwryeq>8 zV8hgTop+7>S~umce;IY*6EC`_NV|8Pp{hyxT9wM9woRgDN&b11xxP{xD5MN48H3a% z)lv0EZ}!^tNe$@H&SNBZ9C*R8dO&6*^iru?2#qbmHtMulX-Q5-8SK2ve53u^} z`dzP@>8*&DNt4J1{*1-tg6lm`S+7S-B=!d0&)*|=n;M};jMqu|+ZJLXEjr+%eD0|yVw)mtvcaa*EChM z;7Rb)J-Y_2O;Gs`e=PVQQWoW@8$0esFvTZ#cR_~g$ldR&;f4!y$of$Tw z*G#tI`DI;YVTyYn8bh=FB8er@jp z)>(73%N!wa$c#kb{rmD8+hw=PAL>}p!4ha+l`?s@)3wA?9hGfm$7RWTBeYoON>_^X zUPn|+vq%0}&-NlS-PQr^?X@Y7w!GqVChf@F!lh=~!2u`MO%=lE*_$rvYQ&ES$&w;P z-{)$@M7*Q2A_p}hn7w=KCgX=A_})9V->6dbz5y=?KXb7o!5p63hsF zxMHmx0%pWsYGL?$XLA&)!g5FC)`}#AehG;m1yj%^?i8WL;$tIf(Dqw(9(OU{aTZzJ|WTF4W$g2AP>ZW7;Pe^hnk_;G(%{IX0 zDvTh@PnRC2a4vCtnt%Ou{l34N96V^ZWUYD!a7?s(q+Oo21Z+4h<>)oELE#_w0IO9a|0Ssj$KIHvWa-)uehu^IxuGR=e}z(uIPk#j)<}PMD-=xGmsnwsFWKSVAjnrU=@8N@ zg{Lj*oh1AEd_^{gJl9m4eqdA9e4KlGs9UN=Wyz_0Pp;knf<}uMym>+l4Q@JLUgmnJ zJ5`}@2D3|6JVM2d3Nioy