Plaid

Ruby bindings for the Plaid API

This version is a beta version that contains failing tests for the new 'info' endpoint. While these have been tested individually on real accounts the tests here will fail with the test accounts supplied. These will be updated soon with test credentials.

Latest stable version: 1.4.3

This version removes the need to use 'type' in each additional call.

**Warning: If you have been using any version < 1 please switch to the correct branch (V0.1.6). Installing without specifying a version from RubyGems results in V1.1 build. **

Add this line to your application's Gemfile:

gem 'plaid'

And install

$ bundle

Or install it system wide as:

$ gem install plaid

Please read the great documentation at http://plaid.com/docs/ for more information.

Configure the gem with your customer id, secret key, and the environment path you would like to use.

Plaid.config do |p|
    p.customer_id = 'Plaid provided customer ID here'
    p.secret = 'Plaid provided secret key here'
    p.environment_location = 'URL for the development or production environment'
end

Example configuration:

Plaid.config do |p|
    p.customer_id = 'CLIENT_ID_TOKEN'
    p.secret = 'SECRET_TOKEN'
    p.environment_location = 'https://tartan.plaid.com/'
end

Authenticate a user to your desired level of api access (auth / connect).

user = Plaid.add_user('auth','plaid_test','plaid_good','wells')

If the authentication requires a pin, you can pass it in as the fifth argument:

user = Plaid.add_user('auth', 'plaid_test', 'plaid_good', 'usaa', '1234')

To add options such as login_only or webhooks, use the sixth argument:

user = Plaid.add_user('auth','plaid_test','plaid_good','wells', nil, { login_only: true, webhooks: 'https://example.org/callbacks/plaid')

Learn about the full functionality of the library on our Wiki

We highly encourage helping out with the gem. Either adding more tests, building new helper classes, fixing bugs, or anything to increase overall quality.

Learn more about best practices, submitting a pull request, and rules for the build on our Wiki