An open API service indexing awesome lists of open source software.

https://github.com/ledermann/ibanomat

Ruby wrapper to calculate the IBAN of german bank account numbers
https://github.com/ledermann/ibanomat

banking german iban ruby rubygems

Last synced: 5 months ago
JSON representation

Ruby wrapper to calculate the IBAN of german bank account numbers

Awesome Lists containing this project

README

          

# IBANomat

[![Build Status](https://github.com/ledermann/ibanomat/actions/workflows/ci.yml/badge.svg)](https://github.com/ledermann/ibanomat/actions)
[![Code Climate](https://codeclimate.com/github/ledermann/ibanomat.svg)](https://codeclimate.com/github/ledermann/ibanomat)
[![Gem Version](https://badge.fury.io/rb/ibanomat.svg)](http://badge.fury.io/rb/ibanomat)

The gem is a Ruby wrapper for a [web service of the german "Sparkasse"](https://www.sparkasse.de/unsere-loesungen/privatkunden/rund-ums-konto/iban-rechner.html). It calculates the **IBAN** for a given bank code (in German "Bankleitzahl") and bank account number ("Kontonummer"). Behind the scenes the web service returns JSON ([Example here](https://www.sparkasse.de/bin/servlets/sparkasse/iban?a=0532013000&b=37040044))

**WARNING: I'm not affiliated in any way with the web service or the Sparkasse. The web service seems not to be official. Maybe it will be offline soon. I didn't find any terms of use on their website. Use this gem at your own risk!**

## Requirements

Ruby 2.0.0 or newer.

## Installation

Add this line to your application's Gemfile:

gem 'ibanomat'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ibanomat

## Usage

```ruby
Ibanomat.find :bank_code => '37040044', :bank_account_number => '532013000'
# =>
# {
# :bank_name => 'Commerzbank',
# :bic => 'COBADEFFXXX',
# :iban => 'DE89370400440532013000',
# :bank_code => '37040044',
# :bank_account_number => '0532013000',
# :return_code => '00'
# }
```

A `return_code` other than '00' indicates a warning or error.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

# Author

Copyright (c) 2013-2023 Georg Ledermann, released under the MIT license