plaid2.model.institutions_get_request module

class plaid2.model.institutions_get_request.InstitutionsGetRequest(*, country_codes: List[str], options: Optional[InstitutionsGetRequestOptions] = None, offset: int, count: int)[source]

Bases: BaseModel

count: int: The total number of Institutions to return.

country_codes: List[str]

Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.

In API versions 2019-05-29 and earlier, the country_codes parameter is an optional parameter within the options object and will default to [US] if it is not supplied.

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

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

offset: int: The number of Institutions to skip.

options: Optional[InstitutionsGetRequestOptions]: An optional object to filter /institutions/get results.

classmethod parse_obj(data: Any) → InstitutionsGetRequest[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) → InstitutionsGetRequest[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw