plaid2.model.item module

class plaid2.model.item.Item(*, webhook: Optional[str] = None, item_id: str, update_type: str, billed_products: List[str], products: Optional[List[str]] = None, consented_products: Optional[List[str]] = None, error: Optional[Error] = None, available_products: List[str], consent_expiration_time: Optional[str] = None, institution_id: Optional[str] = None)

Bases: BaseModel

available_products: List[str]

A list of products available for the Item that have not yet been accessed. The contents of this array will be mutually exclusive with billed_products.

billed_products: List[str]

A list of products that have been billed for the Item. The contents of this array will be mutually exclusive with available_products. Note - billed_products is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance, will not appear here.

consent_expiration_time: Optional[str]

The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the ITEM_LOGIN_REQUIRED error state. To circumvent the ITEM_LOGIN_REQUIRED error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.

Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.

consented_products: Optional[List[str]]

A list of products that have gone through consent collection for the Item. Only present for those enabled in the beta.

Type

Beta

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

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

error: Optional[Error]

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by error_type. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be null if no error has occurred.

institution_id: Optional[str]

The Plaid Institution ID associated with the Item. Field is null for Items created via Same Day Micro-deposits.

item_id: str

The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.

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

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

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

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

products: Optional[List[str]]

A list of authorized products for the Item.

update_type: str

Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.

background - Item can be updated in the background

user_present_required - Item requires user interaction to be updated

webhook: Optional[str]

The URL registered to receive webhooks for the Item.