class

Plaid::InstitutionsGetRequestOptions

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

An optional object to filter /institutions/get results.

Constants

MIN_ITEMS_FOR_PRODUCTS = 1

Constructors

new(pull : JSON::PullParser)

Source

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

Source

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

Source

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

hash(hasher)

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

include_auth_metadata

When true, returns metadata related to the Auth product indicating which auth methods are supported.

Source

include_auth_metadata=(new_value : Bool | Nil)

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

Source

include_optional_metadata

When true, return the institution's homepage URL, logo and primary brand color. Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.

Source

include_optional_metadata=(new_value : Bool | Nil)

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

Source

include_payment_initiation_metadata

When true, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.

Source

include_payment_initiation_metadata=(new_value : Bool | Nil)

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

Source

list_invalid_properties

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

Source

oauth

Limit results to institutions with or without OAuth login flows. Note that institutions will have oauth set to true if some Items associated with that institution are required to use OAuth flows; institutions in a state of migration to OAuth will have the oauth attribute set to true.

Source

oauth=(new_value : Bool | Nil)

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

Source

oauth_present=(oauth_present : Bool)

Source

oauth_present?

Source

products

Filter the Institutions based on which products they support.

Source

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

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

Source

products_present=(products_present : Bool)

Source

products_present?

Source

routing_numbers

Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array. Routing number records used for this matching are not comprehensive; failure to match a given routing number to an institution does not mean that the institution is unsupported by Plaid.

Source

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

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

Source

routing_numbers_present=(routing_numbers_present : Bool)

Source

routing_numbers_present?

Source

valid?

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

Source