Paiement CIC

Paiement CIC is a plugin to ease credit card payment with the CIC / Credit Mutuel banks system version 3.0. It's a Ruby on Rails port of the connexion kits published by the bank.

• The bank's API official website

INSTALL

In your Gemfile

gem 'paiement_cic', :git => 'git://github.com/gbarillot/paiementcic.git'

USAGE

Create a paiement_cic.yml config file in Rails.root/config:

development:
  # Hmac key calculated with the js calculator given by CIC
  hmac_key: "AA123456AAAAAA789123BBBBBB123456CCCCCC12345678"

  # TPE number
  tpe: "010203"

  # Version
  version: "3.0"

  # Merchant name
  societe: "marchantname"

  # Bank gateway URL
  target_url: "https://paiement.creditmutuel.fr/test/paiement.cgi"

  # Auto response URL
  url_retour: 'http://return.fr'

  # Success return path
  url_retour_ok: 'http://return.ok'

  # Error/cancel return path
  url_retour_err: 'http://return.err'

production:
  # Should be mostly the same as above, except target_url
  hmac_key: "AA123456AAAAAA789123BBBBBB123456CCCCCC12345678"
  tpe: "010203"
  version: "3.0"
  societe: "merchantname"
  target_url: "https://paiement.creditmutuel.fr/paiement.cgi"
  url_retour: 'http://return.fr'
  url_retour_ok: 'http://return.ok'
  url_retour_err: 'http://return.err'

Note: this file must be named exactly 'paiement_cic.yml' or an exception would be raised

In the controller :

class PaymentsController < ApplicationController

  def index
    # :montant and :reference are required, you can also add :text_libre, :lgue and :mail arguements if needed
    @request = PaiementCic.new.request(:montant => '123', :reference => '456')
  end

Then in the view, generate the form :

The form generated is populated with hidden fields that will be sent to the bank gateway

# :button_text and :button_class are optionnal, use them for style cutomization if needed
= paiement_cic_form(@request, :button_text => 'Payer', :button_class => 'btn btn-pink')

Now, listen to the bank transaction result :

Just add a create action in your paiement controller

class PaymentsController < ApplicationController

  protect_from_forgery :except => [:create]

  def index
    # :montant and :reference are required, you can also add :text_libre, :lgue and :mail arguments if needed
    @request = PaiementCic.new.request(:montant => '123', :reference => '456')
  end

  def create
    @response = PaiementCic.new.response(params)

    # Save and/or process the order 
  end

  ...

The @response variable contains all the regular Rails params received from the bank, plus an extra :success boolean parameter.

Contributors

• Novelys Team : original gem and cryptographic stuff
• Guillaume Barillot : refactoring and usage simplification

Licence

released under the MIT license