class Plaid::LinkTokenAccountFilters
- Plaid::LinkTokenAccountFilters
- Reference
- Object
Overview
By default, Link will provide limited account filtering: it will only display Institutions that are compatible with all products supplied in the products
parameter of /link/token/create
, and, if auth
is specified in the products
array, will also filter out accounts other than checking
and savings
accounts on the Account Select pane. You can further limit the accounts shown in Link by using account_filters
to specify the account subtypes to be shown in Link. Only the specified subtypes will be shown. This filtering applies to both the Account Select view (if enabled) and the Institution Select view. Institutions that do not support the selected subtypes will be omitted from Link. To indicate that all subtypes should be shown, use the value \"all\"
. If the account_filters
filter is used, any account type for which a filter is not specified will be entirely omitted from Link. For a full list of valid types and subtypes, see the Account schema. The filter may or may not impact the list of accounts shown by the institution in the OAuth account selection flow, depending on the specific institution. If the user selects excluded account subtypes in the OAuth flow, these accounts will not be added to the Item. If the user selects only excluded account subtypes, the link attempt will fail and the user will be prompted to try again.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
plaid/models/link_token_account_filters.crConstructors
- .new(pull : JSON::PullParser)
-
.new(*, depository : DepositoryFilter | Nil = nil, credit : CreditFilter | Nil = nil, loan : LoanFilter | Nil = nil, investment : InvestmentFilter | Nil = nil, other : OtherFilter | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Summary
-
#==(other : self)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #credit : CreditFilter | Nil
-
#credit=(new_value : CreditFilter | Nil)
Custom attribute writer method checking allowed values (enum).
- #depository : DepositoryFilter | Nil
-
#depository=(new_value : DepositoryFilter | Nil)
Custom attribute writer method checking allowed values (enum).
-
#hash(hasher)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #investment : InvestmentFilter | Nil
-
#investment=(new_value : InvestmentFilter | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
- #loan : LoanFilter | Nil
-
#loan=(new_value : LoanFilter | Nil)
Custom attribute writer method checking allowed values (enum).
- #other : OtherFilter | Nil
-
#other=(new_value : OtherFilter | Nil)
Custom attribute writer method checking allowed values (enum).
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
Instance methods inherited from module OpenApi::Json
after_initialize
after_initialize,
eql?(o : self)
eql?,
to_hash : Hash(String, JSON::Any)
to_hash,
to_json_any : JSON::Any
to_json_any
Class methods inherited from module OpenApi::Json
build_from_hash(hash : Hash)
build_from_hash,
build_from_json_any(json_any : JSON::Any)
build_from_json_any
Instance methods inherited from module OpenApi::Validatable
list_invalid_properties : Array(String)
list_invalid_properties,
list_invalid_properties_for(key : String) : Array(String)
list_invalid_properties_for,
valid? : Bool
valid?,
validate : Nil
validate
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] credit Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] depository Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] investment Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] loan Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] other Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid