Class ActiveMerchant::Billing::OgoneGateway
In: lib/active_merchant/billing/gateways/ogone.rb
Parent: Gateway

Ogone DirectLink Gateway

DirectLink is the API version of the Ogone Payment Platform. It allows server to server communication between Ogone systems and your e-commerce website.

This implementation follows the specification provided in the DirectLink integration guide version 4.2.0 (26 October 2011), available here: secure.ogone.com/ncol/Ogone_DirectLink_EN.pdf

It also features aliases, which allow to store/unstore credit cards, as specified in the Alias Manager Option guide version 3.2.0 (26 October 2011) available here: secure.ogone.com/ncol/Ogone_Alias_EN.pdf

It was last tested on Release 4.89 of Ogone DirectLink + AliasManager (26 October 2011).

For any questions or comments, please contact one of the following:

  • Nicolas Jacobeus (nj@belighted.com),
  • Sébastien Grosjean (public@zencocoon.com),
  • Rémy Coutable (remy@jilion.com).

Usage

  gateway = ActiveMerchant::Billing::OgoneGateway.new(
              :login                     => "my_ogone_psp_id",
              :user                      => "my_ogone_user_id",
              :password                  => "my_ogone_pswd",
              :signature                 => "my_ogone_sha_signature", # Only if you configured your Ogone environment so.
              :signature_encryptor       => "sha512", # Can be "sha1" (default), "sha256" or "sha512".
                                                      # Must be the same as the one configured in your Ogone account.
           )

  # set up credit card object as in main ActiveMerchant example
  creditcard = ActiveMerchant::Billing::CreditCard.new(
    :type       => 'visa',
    :number     => '4242424242424242',
    :month      => 8,
    :year       => 2009,
    :first_name => 'Bob',
    :last_name  => 'Bobsen'
  )

  # run request
  response = gateway.purchase(1000, creditcard, :order_id => "1") # charge 10 EUR

  If you don't provide an :order_id, the gateway will generate a random one for you.

  puts response.success?      # Check whether the transaction was successful
  puts response.message       # Retrieve the message returned by Ogone
  puts response.authorization # Retrieve the unique transaction ID returned by Ogone

Alias feature

  To use the alias feature, simply add :store in the options hash:

  # Associate the alias to that credit card
  gateway.purchase(1000, creditcard, :order_id => "1", :store => "myawesomecustomer")

  # You can use the alias instead of the credit card for subsequent orders
  gateway.purchase(2000, "myawesomecustomer", :order_id => "2")

Methods

authorize   capture   credit   new   purchase   refund   test?   void  

Constants

URLS = { :order => 'https://secure.ogone.com/ncol/%s/orderdirect.asp', :maintenance => 'https://secure.ogone.com/ncol/%s/maintenancedirect.asp'
CVV_MAPPING = { 'OK' => 'M', 'KO' => 'N', 'NO' => 'P' }
AVS_MAPPING = { 'OK' => 'M', 'KO' => 'N', 'NO' => 'R' }
SUCCESS_MESSAGE = "The transaction was successful"
OGONE_NO_SIGNATURE_DEPRECATION_MESSAGE = "Signature usage will be required from a future release of ActiveMerchant's Ogone Gateway. Please update your Ogone account to use it."
OGONE_LOW_ENCRYPTION_DEPRECATION_MESSAGE = "SHA512 signature encryptor will be required from a future release of ActiveMerchant's Ogone Gateway. Please update your Ogone account to use it."

Public Class methods

Public Instance methods

Verify and reserve the specified amount on the account, without actually doing the transaction.

Complete a previously authorized transaction.

Credit the specified account by a specific amount.

Verify and transfer the specified amount.

Refund of a settled transaction

Cancels a previously authorized transaction.

[Validate]