com.plaid.client.model

Class Institution

java.lang.Object

com.plaid.client.model.Institution

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T17:46:09.980340Z[Etc/UTC]")
public class Institution
extends Object

Details relating to a specific financial institution

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_AUTH_METADATA
static String	SERIALIZED_NAME_COUNTRY_CODES
static String	SERIALIZED_NAME_INSTITUTION_ID
static String	SERIALIZED_NAME_LOGO
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_OAUTH
static String	SERIALIZED_NAME_PAYMENT_INITIATION_METADATA
static String	SERIALIZED_NAME_PRIMARY_COLOR
static String	SERIALIZED_NAME_PRODUCTS
static String	SERIALIZED_NAME_ROUTING_NUMBERS
static String	SERIALIZED_NAME_STATUS
static String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor and Description
Institution()

Method Summary

Modifier and Type	Method and Description
Institution	addCountryCodesItem(CountryCode countryCodesItem)
Institution	addProductsItem(Products productsItem)
Institution	addRoutingNumbersItem(String routingNumbersItem)
Institution	authMetadata(AuthMetadata authMetadata)
Institution	countryCodes(List<CountryCode> countryCodes)
boolean	equals(Object o)
AuthMetadata	getAuthMetadata() Get authMetadata
List<CountryCode>	getCountryCodes() A list of the country codes supported by the institution.
String	getInstitutionId() Unique identifier for the institution
String	getLogo() Base64 encoded representation of the institution's logo
String	getName() The official name of the institution
Boolean	getOauth() Indicates that the institution has a mandatory OAuth login flow.
PaymentInitiationMetadata	getPaymentInitiationMetadata() Get paymentInitiationMetadata
String	getPrimaryColor() Hexadecimal representation of the primary color used by the institution
List<Products>	getProducts() A list of the Plaid products supported by the institution.
List<String>	getRoutingNumbers() A partial list of routing numbers associated with the institution.
InstitutionStatus	getStatus() Get status
String	getUrl() The URL for the institution's website
int	hashCode()
Institution	institutionId(String institutionId)
Institution	logo(String logo)
Institution	name(String name)
Institution	oauth(Boolean oauth)
Institution	paymentInitiationMetadata(PaymentInitiationMetadata paymentInitiationMetadata)
Institution	primaryColor(String primaryColor)
Institution	products(List<Products> products)
Institution	routingNumbers(List<String> routingNumbers)
void	setAuthMetadata(AuthMetadata authMetadata)
void	setCountryCodes(List<CountryCode> countryCodes)
void	setInstitutionId(String institutionId)
void	setLogo(String logo)
void	setName(String name)
void	setOauth(Boolean oauth)
void	setPaymentInitiationMetadata(PaymentInitiationMetadata paymentInitiationMetadata)
void	setPrimaryColor(String primaryColor)
void	setProducts(List<Products> products)
void	setRoutingNumbers(List<String> routingNumbers)
void	setStatus(InstitutionStatus status)
void	setUrl(String url)
Institution	status(InstitutionStatus status)
String	toString()
Institution	url(String url)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_INSTITUTION_ID

public static final String SERIALIZED_NAME_INSTITUTION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_PRODUCTS

public static final String SERIALIZED_NAME_PRODUCTS

See Also:

Constant Field Values

SERIALIZED_NAME_COUNTRY_CODES

public static final String SERIALIZED_NAME_COUNTRY_CODES

See Also:

Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

Constant Field Values

SERIALIZED_NAME_PRIMARY_COLOR

public static final String SERIALIZED_NAME_PRIMARY_COLOR

See Also:

Constant Field Values

SERIALIZED_NAME_LOGO

public static final String SERIALIZED_NAME_LOGO

See Also:

Constant Field Values

SERIALIZED_NAME_ROUTING_NUMBERS

public static final String SERIALIZED_NAME_ROUTING_NUMBERS

See Also:

Constant Field Values

SERIALIZED_NAME_OAUTH

public static final String SERIALIZED_NAME_OAUTH

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_INITIATION_METADATA

public static final String SERIALIZED_NAME_PAYMENT_INITIATION_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_AUTH_METADATA

public static final String SERIALIZED_NAME_AUTH_METADATA

See Also:

Constant Field Values

Constructor Detail

Institution

public Institution()

Method Detail

institutionId

public Institution institutionId(String institutionId)

getInstitutionId

public String getInstitutionId()

Unique identifier for the institution

Returns:

institutionId

setInstitutionId

public void setInstitutionId(String institutionId)

name

public Institution name(String name)

getName

public String getName()

The official name of the institution

Returns:

name

setName

public void setName(String name)

products

public Institution products(List<Products> products)

addProductsItem

public Institution addProductsItem(Products productsItem)

getProducts

public List<Products> getProducts()

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](https://plaid.com/docs/auth/coverage/).

Returns:

products

setProducts

public void setProducts(List<Products> products)

countryCodes

public Institution countryCodes(List<CountryCode> countryCodes)

addCountryCodesItem

public Institution addCountryCodesItem(CountryCode countryCodesItem)

getCountryCodes

public List<CountryCode> getCountryCodes()

A list of the country codes supported by the institution.

Returns:

countryCodes

setCountryCodes

public void setCountryCodes(List<CountryCode> countryCodes)

url

public Institution url(String url)

getUrl

@Nullable
public String getUrl()

The URL for the institution's website

Returns:

url

setUrl

public void setUrl(String url)

primaryColor

public Institution primaryColor(String primaryColor)

getPrimaryColor

@Nullable
public String getPrimaryColor()

Hexadecimal representation of the primary color used by the institution

Returns:

primaryColor

setPrimaryColor

public void setPrimaryColor(String primaryColor)

logo

public Institution logo(String logo)

getLogo

@Nullable
public String getLogo()

Base64 encoded representation of the institution's logo

Returns:

logo

setLogo

public void setLogo(String logo)

routingNumbers

public Institution routingNumbers(List<String> routingNumbers)

addRoutingNumbersItem

public Institution addRoutingNumbersItem(String routingNumbersItem)

getRoutingNumbers

public List<String> getRoutingNumbers()

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.

Returns:

routingNumbers

setRoutingNumbers

public void setRoutingNumbers(List<String> routingNumbers)

oauth

public Institution oauth(Boolean oauth)

getOauth

public Boolean getOauth()

Indicates that the institution has a mandatory OAuth login flow. Note that `oauth` may be `false` even for institutions that support OAuth, if the institution is in the process of migrating to OAuth and some active Items still exist that do not use OAuth.

Returns:

oauth

setOauth

public void setOauth(Boolean oauth)

status

public Institution status(InstitutionStatus status)

getStatus

@Nullable
public InstitutionStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(InstitutionStatus status)

paymentInitiationMetadata

public Institution paymentInitiationMetadata(PaymentInitiationMetadata paymentInitiationMetadata)

getPaymentInitiationMetadata

@Nullable
public PaymentInitiationMetadata getPaymentInitiationMetadata()

Get paymentInitiationMetadata

Returns:

paymentInitiationMetadata

setPaymentInitiationMetadata

public void setPaymentInitiationMetadata(PaymentInitiationMetadata paymentInitiationMetadata)

authMetadata

public Institution authMetadata(AuthMetadata authMetadata)

getAuthMetadata

@Nullable
public AuthMetadata getAuthMetadata()

Get authMetadata

Returns:

authMetadata

setAuthMetadata

public void setAuthMetadata(AuthMetadata authMetadata)

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