plaid2.model.institution module
- class plaid2.model.institution.Institution(*, institution_id: str, products: List[str], payment_initiation_metadata: Optional[PaymentInitiationMetadata] = None, country_codes: List[str], routing_numbers: List[str], logo: Optional[str] = None, url: Optional[str] = None, primary_color: Optional[str] = None, name: str, status: Optional[InstitutionStatus] = None, auth_metadata: Optional[AuthSupportedMethods] = None, oauth: bool)[source]
Bases:
BaseModel- auth_metadata: Optional[AuthSupportedMethods]
Metadata that captures information about the Auth features of an institution.
- country_codes: List[str]
A list of the country codes supported by the institution.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- institution_id: str
Unique identifier for the institution
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- logo: Optional[str]
Base64 encoded representation of the institution’s logo
- name_: str
The official name of the institution
- oauth: bool
Indicates that the institution has an OAuth login flow.
- classmethod parse_obj(data: Any) Institution[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) Institution[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- payment_initiation_metadata: Optional[PaymentInitiationMetadata]
Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.
- primary_color: Optional[str]
Hexadecimal representation of the primary color used by the institution
- products: List[str]
//plaid.com/docs/auth/coverage/).
- Type
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
- routing_numbers: List[str]
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.
- status: Optional[InstitutionStatus]
The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution’s status, Plaid will return null rather than potentially inaccurate data.
Institution status is accessible in the Dashboard and via the API using the /institutions/get_by_id endpoint with the include_status option set to true. Note that institution status is not available in the Sandbox environment.
- url: Optional[str]
The URL for the institution’s website