Ogone Payment Module Documentation

Last modified by egwada on Wed, June 23, 2010 16:32
Source|Old Revisions  

This is an old revision of the document!


The Magento Ogone Module provides an interface to the Ogone Getaway payment. In fact, it allows you to offer to your customers to choose some payment modes you have activated through your Ogone e-Commerce back office.

Test or Production

This module has two execution modes : Test or Production. The test url and the production url of Ogone are defined in the ogone/etc/mage_ogone.xml.

How it works ?

With the configuration payment you could setup different options like colors, templates, more technical features.

So, when your customer is ready to pay he chooses between the deferent payment modules you have activated in Magento. If the Magento Ogone Module is active and customers choose this one to pay their order a list of all allowed cards and operators appear. Customers click on what they want and confirm to pay. So it will be redirected to the Ogone Payment page that you can customize. After a valid or and invalid transaction customers could come back to your site. In your Ogone settings back office you can select to send a confirmation of the transaction to the customer. For that the Magento Ogone Module transmit the customers email address to Ogone platform. To secure the exchange the module crypt a string that certify data sent and received. A specific field configuration is mandatory (Key encrypted exchanges). If the transaction is validated orders will be in a spending state (for the moment). You have to change the state in the Magento Admin.

How configure it ?

Title Option Definition Option
Test mode Defines if the module is in test mode or not.
Enabled Defines if you active the module or not
Title Indicates the module title. Is the designation which the customer will see.
Ogone Identifier Is your Ogone Identifier (PSPID)
Key encrypted exchanges Is the SHA signature which is used to crypt the … You have to active this option in the Ogone back office. - -
Currency Select the currency allowed. For now only one selected currency.
Language The language in which the Ogone Page will be presented to customers.
Ogone Payment Title Page Title of you Ogone Payment page
Page Background Color Background color for static template
Text Color Text color for static template
Table Background Color Table background color for static template
Table Text Color Table text color for static template
Button Background Color Button background color for static template
Button Text Color Button text color for static template
Font Type Font Type for static template: default = Verdana
Logo Logo filename for static template. You have to send your logo to Ogone support with your PSPID in the subject.
Template Url page The full URL of the Template Page hosted on a secure site with a validated (not expired) “certificat” and containing the “payment string” eg: http://www.MyEcommerceSite.com/TemplatePage.htm or templateSTD3.htm
Payment Success Url redirection page The url if the transaction succeeds. By default it must be : {Magento Base Url}/ogone/ogone/success/
Payment Failure Url redirection page The url if the transaction fails. By default it must be : {Magento Base Url}/ogone/ogone/error
Error Url redirection page The url if the transaction is canceled. By default it must be : {Magento Base Url}/ogone/ogone/error
Canceled Payment Url redirection page The url if the transaction is canceled. By default it must be : {Magento Base Url}/ogone/ogone/decline/
Home Site Url The url of your site
Catalog Url The url of you catalog : {Magento Base Url}/
Payment Methods Select which payment methods (Brand and Operator) that you want. You must select the same you activated on the Ogone back office.
New order status The status after a payment succeds.

Source codes: directories and files

This module will continue to be update but perhaps you would need to make some modifications for your own Magento ecommerce site; that’s why I explain where you could have to change some presentation or behaviors.


{MAGENTO_INSTALLATION}/app/etc/modules/Mage_Ogone.xml : declares the Magento Ogone module

{MAGENTO_INSTALLATION}/app/code/local/Mage/Ogone : this directory is the core of this module. Inside you have the {MAGENTO_INSTALLATION}/app/code/local/Mage/Ogone/Model/Method/Ogone.php describes the principal Magento Ogone module class. If you want to change de behavior of this modul see the controler class : {MAGENTO_INSTALLATION}/app/code/local/Mage/Ogone/controllers/OgoneController.php


To modify the look of the block see in this directory: {MAGENTO_INSTALLATION}/app/design/frontend/default/default/template/Ogone/


Today this module is translated in french and english. I invite you to translate in your own language and send me the translation. You can find the file to be translated here: {MAGENTO_INSTALLATION}/app/locale/fr_FR/Mage_Ogone.csv {MAGENTO_INSTALLATION}/app/locale/en_US/Mage_Ogone.csv


You also have some code for the admin part here: {MAGENTO_INSTALLATION}/app/design/adminhtml/default/default/template/Ogone/