plaid2.model.institutions_get_by_id_request_options module

class plaid2.model.institutions_get_by_id_request_options.InstitutionsGetByIdRequestOptions(*, include_payment_initiation_metadata: Optional[bool] = None, include_optional_metadata: Optional[bool] = None, include_status: Optional[bool] = None, include_auth_metadata: Optional[bool] = None)

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any]

Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

include_auth_metadata: Optional[bool]

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

include_optional_metadata: Optional[bool]

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.

include_payment_initiation_metadata: Optional[bool]

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

include_status: Optional[bool]

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

json(**kwargs: Any) → str

Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

classmethod parse_obj(data: Any) → InstitutionsGetByIdRequestOptions

Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsGetByIdRequestOptions

Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw