com.plaid.client.model

Class InstitutionStatus

java.lang.Object

com.plaid.client.model.InstitutionStatus

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class InstitutionStatus
extends Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_AUTH
static String	SERIALIZED_NAME_HEALTH_INCIDENTS
static String	SERIALIZED_NAME_IDENTITY
static String	SERIALIZED_NAME_INVESTMENTS
static String	SERIALIZED_NAME_INVESTMENTS_UPDATES
static String	SERIALIZED_NAME_ITEM_LOGINS
static String	SERIALIZED_NAME_LIABILITIES
static String	SERIALIZED_NAME_LIABILITIES_UPDATES
static String	SERIALIZED_NAME_TRANSACTIONS_UPDATES

Constructor Summary

Constructors

Constructor and Description
InstitutionStatus()

Method Summary

Modifier and Type	Method and Description
InstitutionStatus	addHealthIncidentsItem(HealthIncident healthIncidentsItem)
InstitutionStatus	auth(ProductStatus auth)
boolean	equals(Object o)
ProductStatus	getAuth() Get auth
List<HealthIncident>	getHealthIncidents() Details of recent health incidents associated with the institution.
ProductStatus	getIdentity() Get identity
ProductStatus	getInvestments() Get investments
ProductStatus	getInvestmentsUpdates() Get investmentsUpdates
ProductStatus	getItemLogins() Get itemLogins
ProductStatus	getLiabilities() Get liabilities
ProductStatus	getLiabilitiesUpdates() Get liabilitiesUpdates
ProductStatus	getTransactionsUpdates() Get transactionsUpdates
int	hashCode()
InstitutionStatus	healthIncidents(List<HealthIncident> healthIncidents)
InstitutionStatus	identity(ProductStatus identity)
InstitutionStatus	investments(ProductStatus investments)
InstitutionStatus	investmentsUpdates(ProductStatus investmentsUpdates)
InstitutionStatus	itemLogins(ProductStatus itemLogins)
InstitutionStatus	liabilities(ProductStatus liabilities)
InstitutionStatus	liabilitiesUpdates(ProductStatus liabilitiesUpdates)
void	setAuth(ProductStatus auth)
void	setHealthIncidents(List<HealthIncident> healthIncidents)
void	setIdentity(ProductStatus identity)
void	setInvestments(ProductStatus investments)
void	setInvestmentsUpdates(ProductStatus investmentsUpdates)
void	setItemLogins(ProductStatus itemLogins)
void	setLiabilities(ProductStatus liabilities)
void	setLiabilitiesUpdates(ProductStatus liabilitiesUpdates)
void	setTransactionsUpdates(ProductStatus transactionsUpdates)
String	toString()
InstitutionStatus	transactionsUpdates(ProductStatus transactionsUpdates)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ITEM_LOGINS

public static final String SERIALIZED_NAME_ITEM_LOGINS

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSACTIONS_UPDATES

public static final String SERIALIZED_NAME_TRANSACTIONS_UPDATES

See Also:

Constant Field Values

SERIALIZED_NAME_AUTH

public static final String SERIALIZED_NAME_AUTH

See Also:

Constant Field Values

SERIALIZED_NAME_IDENTITY

public static final String SERIALIZED_NAME_IDENTITY

See Also:

Constant Field Values

SERIALIZED_NAME_INVESTMENTS_UPDATES

public static final String SERIALIZED_NAME_INVESTMENTS_UPDATES

See Also:

Constant Field Values

SERIALIZED_NAME_LIABILITIES_UPDATES

public static final String SERIALIZED_NAME_LIABILITIES_UPDATES

See Also:

Constant Field Values

SERIALIZED_NAME_LIABILITIES

public static final String SERIALIZED_NAME_LIABILITIES

See Also:

Constant Field Values

SERIALIZED_NAME_INVESTMENTS

public static final String SERIALIZED_NAME_INVESTMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_HEALTH_INCIDENTS

public static final String SERIALIZED_NAME_HEALTH_INCIDENTS

See Also:

Constant Field Values

Constructor Detail

InstitutionStatus

public InstitutionStatus()

Method Detail

itemLogins

public InstitutionStatus itemLogins(ProductStatus itemLogins)

getItemLogins

@Nullable
public ProductStatus getItemLogins()

Get itemLogins

Returns:

itemLogins

setItemLogins

public void setItemLogins(ProductStatus itemLogins)

transactionsUpdates

public InstitutionStatus transactionsUpdates(ProductStatus transactionsUpdates)

getTransactionsUpdates

@Nullable
public ProductStatus getTransactionsUpdates()

Get transactionsUpdates

Returns:

transactionsUpdates

setTransactionsUpdates

public void setTransactionsUpdates(ProductStatus transactionsUpdates)

auth

public InstitutionStatus auth(ProductStatus auth)

getAuth

@Nullable
public ProductStatus getAuth()

Get auth

Returns:

auth

setAuth

public void setAuth(ProductStatus auth)

identity

public InstitutionStatus identity(ProductStatus identity)

getIdentity

@Nullable
public ProductStatus getIdentity()

Get identity

Returns:

identity

setIdentity

public void setIdentity(ProductStatus identity)

investmentsUpdates

public InstitutionStatus investmentsUpdates(ProductStatus investmentsUpdates)

getInvestmentsUpdates

@Nullable
public ProductStatus getInvestmentsUpdates()

Get investmentsUpdates

Returns:

investmentsUpdates

setInvestmentsUpdates

public void setInvestmentsUpdates(ProductStatus investmentsUpdates)

liabilitiesUpdates

public InstitutionStatus liabilitiesUpdates(ProductStatus liabilitiesUpdates)

getLiabilitiesUpdates

@Nullable
public ProductStatus getLiabilitiesUpdates()

Get liabilitiesUpdates

Returns:

liabilitiesUpdates

setLiabilitiesUpdates

public void setLiabilitiesUpdates(ProductStatus liabilitiesUpdates)

liabilities

public InstitutionStatus liabilities(ProductStatus liabilities)

getLiabilities

@Nullable
public ProductStatus getLiabilities()

Get liabilities

Returns:

liabilities

setLiabilities

public void setLiabilities(ProductStatus liabilities)

investments

public InstitutionStatus investments(ProductStatus investments)

getInvestments

@Nullable
public ProductStatus getInvestments()

Get investments

Returns:

investments

setInvestments

public void setInvestments(ProductStatus investments)

healthIncidents

public InstitutionStatus healthIncidents(List<HealthIncident> healthIncidents)

addHealthIncidentsItem

public InstitutionStatus addHealthIncidentsItem(HealthIncident healthIncidentsItem)

getHealthIncidents

@Nullable
public List<HealthIncident> getHealthIncidents()

Details of recent health incidents associated with the institution.

Returns:

healthIncidents

setHealthIncidents

public void setHealthIncidents(List<HealthIncident> healthIncidents)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object