class Plaid::InstitutionStatus

• Plaid::InstitutionStatus
• Reference
• Object

Overview

The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution's status, Plaid will return null rather than potentially inaccurate data. Institution status is accessible in the Dashboard and via the API using the /institutions/get_by_id endpoint with the include_status option set to true. Note that institution status is not available in the Sandbox environment.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

plaid/models/institution_status.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(*, item_logins : ProductStatus | Nil = nil, transactions_updates : ProductStatus | Nil = nil, auth : ProductStatus | Nil = nil, identity : ProductStatus | Nil = nil, investments_updates : ProductStatus | Nil = nil, liabilities_updates : ProductStatus | Nil = nil, liabilities : ProductStatus | Nil = nil, investments : ProductStatus | Nil = nil, health_incidents : Array(HealthIncident) | 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.

• #auth : ProductStatus | Nil
• #auth=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #auth_present=(auth_present : Bool)
• #auth_present? : Bool
• #hash(hasher)

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

• #health_incidents : Array(HealthIncident) | Nil
• #health_incidents=(new_value : Array(HealthIncident) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #health_incidents_present=(health_incidents_present : Bool)
• #health_incidents_present? : Bool
• #identity : ProductStatus | Nil
• #identity=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #identity_present=(identity_present : Bool)
• #identity_present? : Bool
• #investments : ProductStatus | Nil
• #investments=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #investments_present=(investments_present : Bool)
• #investments_present? : Bool
• #investments_updates : ProductStatus | Nil
• #investments_updates=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #investments_updates_present=(investments_updates_present : Bool)
• #investments_updates_present? : Bool
• #item_logins : ProductStatus | Nil
• #item_logins=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #item_logins_present=(item_logins_present : Bool)
• #item_logins_present? : Bool
• #liabilities : ProductStatus | Nil
• #liabilities=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #liabilities_present=(liabilities_present : Bool)
• #liabilities_present? : Bool
• #liabilities_updates : ProductStatus | Nil
• #liabilities_updates=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #liabilities_updates_present=(liabilities_updates_present : Bool)
• #liabilities_updates_present? : Bool
• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #transactions_updates : ProductStatus | Nil
• #transactions_updates=(new_value : ProductStatus | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transactions_updates_present=(transactions_updates_present : Bool)
• #transactions_updates_present? : Bool
• #valid? : Bool

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

Constructor Detail

Instance Method Detail