Struct plaid::model::Item

pub struct Item {
    pub available_products: Vec<String>,
    pub billed_products: Vec<String>,
    pub consent_expiration_time: Option<DateTime<Utc>>,
    pub consented_products: Option<Vec<String>>,
    pub error: Option<PlaidError>,
    pub institution_id: Option<String>,
    pub item_id: String,
    pub products: Option<Vec<String>>,
    pub update_type: String,
    pub webhook: Option<String>,
}

Metadata about the Item.

Fields

available_products: Vec<String>

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: Vec<String>

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: Option<DateTime<Utc>>

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: Option<Vec<String>>

A list of products that have gone through consent collection for the Item. Only present for those enabled in the Data Transparency beta. If you are not enrolled in Data Transparency, this field is not used.

error: Option<PlaidError>

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. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.

institution_id: Option<String>

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

item_id: String

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.

products: Option<Vec<String>>

A list of products added to the Item. In almost all cases, this will be the same as the billed_products field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products but not in billed_products.

update_type: String

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: Option<String>

The URL registered to receive webhooks for the Item.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Item

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Item

fn default() -> Item

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Item

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Item

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for Item

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.