Flinks

A ruby client for the Flinks API.

Build Status Gem Version Maintainability Test Coverage

Installation

gem install flinks

Or with bundler:

gem 'flinks', require: 'flinks'

Usage

This library needs to be configured with your API customer ID and API endpoint.

flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'], api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/")

Configure on_error to catch API requests returning a 400..599 HTTP status.

flinks = Flinks.new({
  customer_id: ENV['FLINKS_CUSTOMER_ID'],
  api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/",
  on_error: Proc.new do |status, message, body|
    p [status, message, body]
  end
})

Configure debug to print every API requests and responses.

flinks = Flinks.new({
  customer_id: ENV['FLINKS_CUSTOMER_ID'],
  api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/",
  debug: true
})

Endpoints

Authorize

  • authorize(login_id:, options:)
  • authorize_with_credentials(username:, password:, institution:, options:)
  • authorize_multiple(login_ids:)

Account

  • accounts_summary(request_id:, options:)
  • accounts_summary_async(request_id:)
  • accounts_detail(request_id:, options:)
  • accounts_detail_async(request_id:)

Card

  • delete_card(card_id:)

Refresh

  • activate_scheduled_refresh(login_id:)
  • deactivate_scheduled_refresh(login_id:)
  • set_scheduled_refresh(activated, login_id:)

Statement

  • statements(options:)
  • statements_async(request_id:)

Documentation

See the API docs.

Supported Ruby versions

  • MRI 2.3
  • MRI 2.4
  • MRI 2.5

Development

Run all tests:

bundle exec rspec

License

MIT