plaid2.model.institutions_search_request_options module

class plaid2.model.institutions_search_request_options.InstitutionsSearchRequestOptions(*, include_optional_metadata: Optional[bool] = None, oauth: Optional[bool] = None, include_payment_initiation_metadata: Optional[bool] = None, payment_initiation: Optional[InstitutionsSearchPaymentInitiationOptions] = None, include_auth_metadata: Optional[bool] = None)[source]

Bases: BaseModel

dict(**kwargs: Any) → Dict[str, Any][source]: 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 the institution’s homepage URL, logo and primary brand color.

include_payment_initiation_metadata: Optional[bool]: When true, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.

json(**kwargs: Any) → str[source]: Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json

oauth: Optional[bool]: Limit results to institutions with or without OAuth login flows.

classmethod parse_obj(data: Any) → InstitutionsSearchRequestOptions[source]: Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj

classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) → InstitutionsSearchRequestOptions[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

payment_initiation: Optional[InstitutionsSearchPaymentInitiationOptions]: Additional options that will be used to filter institutions by various Payment Initiation configurations.