plaid2.model.transaction_base module
- class plaid2.model.transaction_base.TransactionBase(*, pending_transaction_id: Optional[str] = None, account_owner: Optional[str] = None, name: Optional[str] = None, amount: float, check_number: Optional[str] = None, original_description: Optional[str] = None, payment_meta: Optional[PaymentMeta] = None, transaction_type: Optional[str] = None, pending: bool, merchant_name: Optional[str] = None, category_id: Optional[str] = None, account_id: str, date: str, unofficial_currency_code: Optional[str] = None, category: Optional[List[str]] = None, location: Optional[Location] = None, transaction_id: str, iso_currency_code: Optional[str] = None)[source]
Bases:
BaseModel- account_id: str
The ID of the account in which this transaction occurred.
- account_owner: Optional[str]
The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
- amount: float
The settled value of the transaction, denominated in the transactions’s currency, as stated in iso_currency_code or unofficial_currency_code. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
- category: Optional[List[str]]
//plaid.com/docs/api/products/transactions/#categoriesget).
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.
- 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).
If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.
- 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.
- date: str
//wikipedia.org/wiki/ISO_8601) format ( YYYY-MM-DD ).
- Type
For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](https
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- iso_currency_code: Optional[str]
The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- merchant_name: Optional[str]
The merchant name, as extracted by Plaid from the name field.
- name_: Optional[str]
The merchant name or transaction description.
If the transactions object was returned by a Transactions endpoint such as /transactions/get, this field will always appear. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.
- original_description: Optional[str]
The string returned by the financial institution to describe the transaction. For transactions returned by /transactions/get, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set options.include_original_description to true.
- classmethod parse_obj(data: Any) TransactionBase[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) TransactionBase[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- payment_meta: Optional[PaymentMeta]
Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null.
If the transactions object was returned by a Transactions endpoint such as /transactions/get, the payment_meta key will always appear, but no data elements are guaranteed. If the transactions object was returned by an Assets endpoint such as /asset_report/get/ or /asset_report/pdf/get, this field will only appear in an Asset Report with Insights.
- pending: bool
When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
- pending_transaction_id: Optional[str]
The ID of a posted transaction’s associated pending transaction, where applicable.
- transaction_id: str
The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.
- transaction_type: Optional[str]
Please use the payment_channel field, transaction_type will be deprecated in the future.
digital: transactions that took place online.
place: transactions that were made at a physical location.
special: transactions that relate to banks, e.g. fees or deposits.
unresolved: transactions that do not fit into the other three types.
- unofficial_currency_code: Optional[str]
The unofficial currency code associated with the transaction. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.