› Equitrac › Web Client › Web Deposit › Web Deposit solution for Ogone › Configuring Web Deposit for Ogone › Configure Ogone

Configure Ogone

After an Ogone account is created, you must configure and activate the account for the e-Commerce payment gateway used by Web Deposit. You must also set the same configuration for test and production accounts:
  1. Log in to the Ogone account. The minimum character requirement is two (2).
  2. There are some error cases (for example, if the currency type that is not allowed is used) when Ogone displays an error page with only a Back to merchant site button. This button navigates to a specified URL that is recommended to be set to the Web Deposit landing page (“https://<address>/EQWebClient/WebDeposit”). To set the URL, select the Account item in the left menu, click the Your administrative details link and set the Website address field.
  3. Configure Your Technical settings in Ogone via the Configuration Technical information menu.
  4. In the Global transaction parameters tab, do the following:
    1. Set “Default operation code” to Sale.
    2. Set “Default data capture (payment) procedure” to Data capture by the merchant (manual or automatic).
    3. Set “Processing for individual transactions” to Online but switch to offline in intervals when the online acquiring system is unavailable.
    4. Set “Default ECI value” to 7 - E-commerce with SSL encryption from the drop-down list.
  5. In the Global security parameters tab, do the following:
    1. Set “Hash algorithm” to SHA-1.
      A hash value is calculated for all communications with Ogone to help maintain the integrity of the messages. You can select the hash algorithm here.
    2. Set “Character encoding” to Use the character encoding expected with the initial transaction request (depending on the URL called).
  6. In the Data and origin verification tab, do the following:
    1. Enter a secure key of random characters (e.g. “abcABC567!@#xy”) in the SHA-IN pass phrase fields. The length of the secure key is between 16 and 128 characters, inclusive.
      Messages received by Ogone must contain the specified secure key to help maintain the integrity of the messages.
  7. In the Transaction feedback tab, do the following:
    1. Ensure that the “Timing of the request” setting is not set to “No request“. Otherwise, payments will not be completed at the Web Deposit.

      Option “Online but switch to a deferred request when the online requests fail” is recommended for the Web Deposit.

    2. Specify the “URL of the merchant’s post-payment page” which can be used from the Internet (outside of the Intranet) to reach Web Deposit.
      This URL must contain an 'http' or 'https' address with default port. A custom port number cannot be used.
      If a payment is initiated through Ogone, the transaction is not performed immediately. The time of the completion depends on the communication between Ogone and the acquirer (e.g. a card holder bank). During this time, Ogone sends notification messages to Web Deposit about the status of the transaction. Thus, it can happen that the transaction is complete (and the balance of the Equitrac account is increased) almost immediately, or in some minutes or hours or days after the initiation of the transaction.
      • Set the “If the payment's status is “accepted”, “on hold” or “uncertain”” field to https://<address>/ EQWebClient/WebDeposit/Ogone/PaymentNotification.
      • Set the “If the payment's status is “canceled by the client” or “too many rejections by the acquirer”” field to https://<address>/EQWebClient/WebDeposit/Ogone/PaymentFailNotification.
    3. Set “Request method” to POST.
    4. Set the “Dynamic e-Commerce Parameters” by selecting the following parameters:
      • ACCEPTANCE
      • AMOUNT
      • CN
      • COMPLUS
      • CURRENCY
      • IP
      • NCERROR
      • ORDERID
      • PAYID
      • STATUS
      • TRXDATE
    5. Select the I would like Ogone to display a “processing” message to the customer during payment processing check box.
    6. Select the I would like Ogone to re-launch the “end of transaction” (post-payment request/redirection) process if required check box.
    7. (optional) Enter a secure key in the SHA-OUT pass phrase field. The length of the secure key should be between 16 and 128 characters, inclusive.
      Messages sent by Ogone to Web Deposit are modified based on the specified secure key. Web Deposit checks the integrity of the messages and decreases the chance of hacking.
  8. Click Confirm changes to save the settings.
  9. Activate your Ogone account (if not already activated).
  10. Make sure that the currency type used in Web Deposit is allowed in Ogone. Select the Account item in the left menu, click on the Currencies link on the right side and make sure that the currency type of Web Deposit is in the list. If not, add it to the list.
  11. Configure Web Deposit properly for your Ogone account and enable the Ogone payment method in Web Deposit.
    1. Edit the “Gateways” table of the “EQWebDeposit” database used by Web Deposit.
    2. Set the “Enabled” column of the “Ogone” record to True.
  12. If necessary, the legal documents can be displayed to the end users for acceptance before the Ogone payment method is used. Web Deposit is prepared for this, the only necessary step is to provide the list of the legal documents:
    1. Edit the “OgoneLegalDocuments” table of the “EQWebDeposit” database used by Web Deposit.
    2. For every legal document add a new record:
      • The “Title” column contains the text which is displayed on the Web Deposit page.
      • The “URL” column contains the URL where the legal document is located.
  13. Set the following Ogone integration settings of Web Deposit.
    1. Edit the already existing record of the “OgoneSettings” table in the “EQWebDeposit” database used by Web Deposit.
    2. The “OgoneUrl” column contains the URL of the Ogone site. By default, it contains the production site URL - https://secure.ogone.com/ncol/prod/orderstandard_utf8.asp. If you want to use a test account, modify it to https://secure.ogone.com/ncol/test/orderstandard_utf8.asp.
    3. Set the Ogone PSPID account name to the “PSPID” column.
    4. Set the security key for sending messages to the “ShaIn” column. Use the same value as set in the "SHA-IN" pass phrase setting of the used Ogone account.
    5. Set the security key for incoming messages to the “ShaOut” column. Use the same value as set in the "SHA-OUT" pass phrase setting of the used Ogone account.
    6. Set a text to the “OrderTitle” column. This text is displayed on the Ogone payment screen.
    7. (optional) Modify the “OrderIdTemplate” column. This is the format of the unique identifier of an Ogone order that contains replacement strings which are replaced by values in real time. After this replacement, the Order ID cannot be longer than 40 characters.
      • “{pid}” is replaced with an automatically incremented number.
      • “{date}” is replaced with the date when the payment is started. Format of the date is yyyyMMddHHmmss, where “yyyy” is the 4-digit year, “MM” is the 2-digit month, “dd” is the 2-digit day, “HH” is the 2-digit hour in 24-hour format, “mm” is the 2-digit minute and finally “ss” is the 2-digit second.
    8. (optional) Update the used colors (by default they are in sync with the Web Deposit design).
  14. Restart the “Equitrac” application pool identity in IIS in order to use the new settings by Web Deposit.