Package com.plaid.client.model

Class InstitutionsGetByIdRequestOptions

java.lang.Object

com.plaid.client.model.InstitutionsGetByIdRequestOptions

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class InstitutionsGetByIdRequestOptions
extends java.lang.Object

Specifies optional parameters for `/institutions/get_by_id`. If provided, must not be `null`.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SERIALIZED_NAME_INCLUDE_AUTH_METADATA
static java.lang.String	SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA
static java.lang.String	SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA
static java.lang.String	SERIALIZED_NAME_INCLUDE_STATUS

Constructor Summary

Constructors

Constructor	Description
InstitutionsGetByIdRequestOptions()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.Boolean	getIncludeAuthMetadata()	When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
java.lang.Boolean	getIncludeOptionalMetadata()	When `true`, return an institution's logo, brand color, and URL.
java.lang.Boolean	getIncludePaymentInitiationMetadata()	When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
java.lang.Boolean	getIncludeStatus()	If `true`, the response will include status information about the institution.
int	hashCode()
InstitutionsGetByIdRequestOptions	includeAuthMetadata(java.lang.Boolean includeAuthMetadata)
InstitutionsGetByIdRequestOptions	includeOptionalMetadata(java.lang.Boolean includeOptionalMetadata)
InstitutionsGetByIdRequestOptions	includePaymentInitiationMetadata(java.lang.Boolean includePaymentInitiationMetadata)
InstitutionsGetByIdRequestOptions	includeStatus(java.lang.Boolean includeStatus)
void	setIncludeAuthMetadata(java.lang.Boolean includeAuthMetadata)
void	setIncludeOptionalMetadata(java.lang.Boolean includeOptionalMetadata)
void	setIncludePaymentInitiationMetadata(java.lang.Boolean includePaymentInitiationMetadata)
void	setIncludeStatus(java.lang.Boolean includeStatus)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA

public static final java.lang.String SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_STATUS

public static final java.lang.String SERIALIZED_NAME_INCLUDE_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_AUTH_METADATA

public static final java.lang.String SERIALIZED_NAME_INCLUDE_AUTH_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA

public static final java.lang.String SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA

See Also:

Constant Field Values

Constructor Details

InstitutionsGetByIdRequestOptions

public InstitutionsGetByIdRequestOptions()

Method Details

includeOptionalMetadata

public InstitutionsGetByIdRequestOptions includeOptionalMetadata(java.lang.Boolean includeOptionalMetadata)

getIncludeOptionalMetadata

@Nullable public java.lang.Boolean getIncludeOptionalMetadata()

When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`. 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.

Returns:

includeOptionalMetadata

setIncludeOptionalMetadata

public void setIncludeOptionalMetadata(java.lang.Boolean includeOptionalMetadata)

includeStatus

public InstitutionsGetByIdRequestOptions includeStatus(java.lang.Boolean includeStatus)

getIncludeStatus

@Nullable public java.lang.Boolean getIncludeStatus()

If `true`, the response will include status information about the institution. Default value is `false`.

Returns:

includeStatus

setIncludeStatus

public void setIncludeStatus(java.lang.Boolean includeStatus)

includeAuthMetadata

public InstitutionsGetByIdRequestOptions includeAuthMetadata(java.lang.Boolean includeAuthMetadata)

getIncludeAuthMetadata

@Nullable public java.lang.Boolean getIncludeAuthMetadata()

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

Returns:

includeAuthMetadata

setIncludeAuthMetadata

public void setIncludeAuthMetadata(java.lang.Boolean includeAuthMetadata)

includePaymentInitiationMetadata

public InstitutionsGetByIdRequestOptions includePaymentInitiationMetadata(java.lang.Boolean includePaymentInitiationMetadata)

getIncludePaymentInitiationMetadata

@Nullable public java.lang.Boolean getIncludePaymentInitiationMetadata()

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

Returns:

includePaymentInitiationMetadata

setIncludePaymentInitiationMetadata

public void setIncludePaymentInitiationMetadata(java.lang.Boolean includePaymentInitiationMetadata)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object