Omnikassa2

This Gem provides the Ruby integration for the new Omnikassa 2.0 JSON API from the Rabobank. The documentation for this API is currently here: Rabobank.nl

Installation

Add this line to your application's Gemfile:

gem 'omnikassa2'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omnikassa2

Configuration

You can find your refresh_token and signing_key in Omnikassa's dashboard. The base_url corresponds with the base_url of the Omnikassa2 API. You can use :sandbox or :production as well.

Omnikassa2.config(
  refresh_token: 'my_refresh_token',
  signing_key: 'my_signing_key',
  base_url: :sandbox # Shortcut for 'https://betalen.rabobank.nl/omnikassa-api-sandbox'
)

For Status Pull, it is required to configure a webhook as well (see official documentation).

Announce order

response = Omnikassa2.announce_order(
  Omnikassa2::MerchantOrder.new(
    merchant_order_id: 'order123',
    amount: Money.new(
      amount: 4999,
      currency: 'EUR'
    ),
    merchant_return_url: 'https://www.example.org/my-webshop'
  )
)

redirect_url = response.redirect_url

# Send client to 'redirect_url'

Omnikassa will now allow the user to pay. When the payment is finished or terminated, the user will be redirected to the given merchant_return_url. These query parameters are order_id, status and signature. We must validate the signature in order to trust the provided parameters:

# pseudocode
class MyLandingPageController
  def get(request)
    params = request.params

    # Validate passed parameters
    valid_params = Omnikassa2::SignatureService.validate(
      params[:order_id] + ',' + params[:status],
      params[:signature]
    )

    if valid_params
      # Params are trusted
      render 'landing_page', order_status: params[:order_status]
    else
      # Params are not trusted
      render 'error_page'
    end
  end
end

Status pull

Performing a status pull is only possible when notified by Omnikassa through a configured webhook in the dashboard.

# pseudocode
class MyOmnikassaWebhookController
  def post(request)
    # Create notification object
    notification = Omnikassa2::Notification.from_json request.body

    # Use notification object to retrieve statusses
    Omnikassa2.status_pull(notification) do |order_status|
      # Do something
      puts "Order: #{ order_status.merchant_order_id}"
      puts "Paid amount: #{ order_status.paid_amount.amount }"
    end
  end
end

Project Status / Contributing

This omnikassa2 gem is actively used within other Kabisa projects but has no regular expected maintenance or releases of itself. We intent to keep this gem functional and strive for high quality, but effort is dependent on related projects.

Bug reports, suggestions, questions and pull requests are all welcome on GitHub at https://github.com/kabisa/omnikassa2, but we can't make any promises on a follow-up.