plaid2.model.institutions_get_request_options module

class plaid2.model.institutions_get_request_options.InstitutionsGetRequestOptions(*, products: Optional[List[str]] = None, include_optional_metadata: Optional[bool] = None, oauth: Optional[bool] = None, include_auth_metadata: Optional[bool] = None, include_payment_initiation_metadata: Optional[bool] = None, routing_numbers: Optional[List[str]] = 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 the institution’s homepage URL, logo and primary brand color.

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.

json(**kwargs: Any) → str

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) → InstitutionsGetRequestOptions

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

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

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

products: Optional[List[str]]

Filter the Institutions based on which products they support.

routing_numbers: Optional[List[str]]

Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array. Routing number records used for this matching are not comprehensive; failure to match a given routing number to an institution does not mean that the institution is unsupported by Plaid.