A class encapsulating information about a Financial Institution supported by Plaid.

Sections
Methods
I
N
T
Public
Attributes
[R] account_locked_url

The String “account locked” URL.

[R] account_setup_url

The String “account setup” URL.

[R] colors

The Hash with color information for the institution.

E.g. { primary: 'rgba(220,20,48,1)', darker: 'rgba(180,11,35,1)', gradient: ['rgba(250,20,51,1)', 'rgba(227,24,55,1)'] }.

[R] fields

The Array of Hashes with login fields information.

E.g. [{ name: 'username', label: 'Online ID', type: 'text' }, { name: 'password', label: 'Password', type: 'password' }].

[R] forgotten_password_url

The String “forgotten password” URL.

[R] id

The String ID of the institution. Same as type. E.g. “bofa”.

[R] logo

The String with base64 encoded logo.

[R] name

The String institution name. E.g. “Bank of America”.

[R] name_break

???.

[R] products

The Hash with supported products as keys and booleans as values.

E.g. { auth: true, balance: true, connect: true, info: true }.

[R] type

The String short name (“type”) of the institution. E.g. “bofa”.

[R] video

The String video (???).

Instance Public methods
inspect()

Get a String representation of the institution.

Returns

Returns a String.

Also aliased as: to_s
# File lib/plaid/institution.rb, line 243
def inspect
  "#<Plaid::SearchResultInstitution id=#{id.inspect}, name=#{name.inspect}, "          '...>'
end
to_s()

Get a String representation of the institution.

Returns

Returns a String.

Alias for: inspect
Internal
Class Public methods
new(hash)

Initialize the SearchResultInstitution instance.

# File lib/plaid/institution.rb, line 226
def initialize(hash)
  %w(id type name video logo).each do |f|
    instance_variable_set "@#{f}", hash[f]
  end

  @products = Plaid.symbolize_hash(hash['products'])
  @forgotten_password_url = hash['forgottenPassword']
  @account_locked_url = hash['accountLocked']
  @account_setup_url = hash['accountSetup']
  @fields = hash['fields'].map { |fld| Plaid.symbolize_hash(fld) }
  @colors = Plaid.symbolize_hash(hash['colors'])
  @name_break = hash['nameBreak']
end