class

Plaid::Institution

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Details relating to a specific financial institution

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, institution_id : String | Nil = nil, name : String | Nil = nil, products : Array(Products) | Nil = nil, country_codes : Array(CountryCode) | Nil = nil, routing_numbers : Array(String) | Nil = nil, oauth : Bool | Nil = nil, url : String | Nil = nil, primary_color : String | Nil = nil, logo : String | Nil = nil, dtc_numbers : Array(String) | Nil = nil, status : InstitutionStatus | Nil = nil, payment_initiation_metadata : PaymentInitiationMetadata | Nil = nil, auth_metadata : AuthMetadata | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

auth_metadata

auth_metadata=(new_value : AuthMetadata | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] auth_metadata Object to be assigned

auth_metadata_present=(auth_metadata_present : Bool)

auth_metadata_present?

country_codes

A list of the country codes supported by the institution.

country_codes=(new_value : Array(CountryCode) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] country_codes Object to be assigned

dtc_numbers

A partial list of DTC numbers associated with the institution.

dtc_numbers=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] dtc_numbers Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

institution_id

Unique identifier for the institution. Note that the same institution may have multiple records, each with different institution IDs; for example, if the institution has migrated to OAuth, there may be separate institution_ids for the OAuth and non-OAuth versions of the institution. Institutions that operate in different countries or with multiple login portals may also have separate institution_ids for each country or portal.

institution_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] institution_id Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

logo

Base64 encoded representation of the institution's logo, returned as a base64 encoded 152x152 PNG. Not all institutions' logos are available.

logo=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] logo Object to be assigned

logo_present=(logo_present : Bool)

logo_present?

name

The official name of the institution.

name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned

oauth

Indicates that the institution has an OAuth login flow. This will be true if OAuth is supported for any Items associated with the institution, even if the institution also supports non-OAuth connections.

oauth=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] oauth Object to be assigned

payment_initiation_metadata

payment_initiation_metadata=(new_value : PaymentInitiationMetadata | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payment_initiation_metadata Object to be assigned

payment_initiation_metadata_present=(payment_initiation_metadata_present : Bool)

payment_initiation_metadata_present?

primary_color

Hexadecimal representation of the primary color used by the institution

primary_color=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] primary_color Object to be assigned

primary_color_present=(primary_color_present : Bool)

primary_color_present?

products

A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return auth in the product array; institutions that do not list auth may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the auth_metadata object. For more details, see Full Auth coverage.

products=(new_value : Array(Products) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] products Object to be assigned

routing_numbers

A partial list of routing numbers associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is not comprehensive and should never be used as a complete list of routing numbers for an institution.

routing_numbers=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] routing_numbers Object to be assigned

status

status=(new_value : InstitutionStatus | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

status_present=(status_present : Bool)

status_present?

url

The URL for the institution's website

url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] url Object to be assigned

url_present=(url_present : Bool)

url_present?

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid