plaid2.model.enhancements module

class plaid2.model.enhancements.Enhancements(*, payment_channel: str, merchant_name: Optional[str] = None, location: Location, personal_finance_category_icon_url: Optional[str] = None, website: Optional[str] = None, category: List[str], personal_finance_category: Optional[PersonalFinanceCategory] = None, logo_url: Optional[str] = None, check_number: Optional[str] = None, category_id: Optional[str] = None)[source]

Bases: BaseModel

category: List[str]

//plaid.com/docs/api/products/transactions/#categoriesget).

Type

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [/categories/get](https

category_id: Optional[str]

//plaid.com/docs/api/products/transactions/#categoriesget).

Type

The ID of the category to which this transaction belongs. For a full list of categories, see [/categories/get](https

check_number: Optional[str]

The check number of the transaction. This field is only populated for check transactions.

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

location: Location

A representation of where a transaction took place

logo_url: Optional[str]

A link to the logo associated with this transaction. The logo will always be 100x100 resolution.

merchant_name: Optional[str]

The merchant name, as extracted by Plaid from the raw description.

classmethod parse_obj(data: Any) Enhancements[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) Enhancements[source]

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

payment_channel: str

The channel used to make a payment. online: transactions that took place online.

in store: transactions that were made at a physical location.

other: transactions that relate to banks, e.g. fees or deposits.

personal_finance_category: Optional[PersonalFinanceCategory]

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.

See the [taxonomy csv file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.

personal_finance_category_icon_url: Optional[str]

A link to the icon associated with the primary personal finance category. The logo will always be 100x100 resolution.

website: Optional[str]

The website associated with this transaction.