plaid2.model.credit_bank_income_transaction module
- class plaid2.model.credit_bank_income_transaction.CreditBankIncomeTransaction(*, unofficial_currency_code: Optional[str] = None, name: Optional[str] = None, amount: Optional[float] = None, check_number: Optional[str] = None, iso_currency_code: Optional[str] = None, pending: Optional[bool] = None, transaction_id: Optional[str] = None, date: Optional[str] = None, original_description: Optional[str] = None)[source]
Bases:
BaseModel- amount: Optional[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, credit card purchases are positive; credit card payment, direct deposits, and refunds are negative.
- check_number: Optional[str]
The check number of the transaction. This field is only populated for check transactions.
- date: Optional[str]
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 format (YYYY-MM-DD).
- 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 amount or balance.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- name_: Optional[str]
The merchant name or transaction description.
- original_description: Optional[str]
The string returned by the financial institution to describe the transaction.
- classmethod parse_obj(data: Any) CreditBankIncomeTransaction[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) CreditBankIncomeTransaction[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- pending: Optional[bool]
When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
- transaction_id: Optional[str]
The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.
- unofficial_currency_code: Optional[str]
The unofficial currency code associated with the amount or balance. 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.