Struct plaid_openapi::TransactionBase

pub struct TransactionBase {

    pub transaction_type: Option<String>,
    pub pending_transaction_id: Option<String>,
    pub category_id: Option<String>,
    pub category: Option<Vec<String>>,
    pub location: Option<Location>,
    pub payment_meta: Option<PaymentMeta>,
    pub account_owner: Option<String>,
    pub name: Option<String>,
    pub original_description: Option<String>,
    pub account_id: String,
    pub amount: f64,
    pub iso_currency_code: Option<String>,
    pub unofficial_currency_code: Option<String>,
    pub date: String,
    pub pending: bool,
    pub transaction_id: String,
    pub merchant_name: Option<String>,
    pub check_number: Option<String>,
}

Fields

transaction_type: Option<String>

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.

pending_transaction_id: Option<String>

The ID of a posted transaction’s associated pending transaction, where applicable.

category_id: Option<String>

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

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.

category: Option<Vec<String>>

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

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.

location: Option<Location>

A representation of where a transaction took place

payment_meta: Option<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.

account_owner: Option<String>

The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.

name: Option<String>

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

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.

account_id: String

The ID of the account in which this transaction occurred.

amount: f64

The settled value of the transaction, denominated in the account’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.

iso_currency_code: Option<String>

The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.

unofficial_currency_code: Option<String>

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 for a full listing of supported iso_currency_codes.

date: String

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 ).

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.

transaction_id: String

The unique ID of the transaction. Like all Plaid identifiers, the transaction_id is case sensitive.

merchant_name: Option<String>

The merchant name, as extracted by Plaid from the name field.

check_number: Option<String>

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

Trait Implementations

impl Debug for TransactionBase

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionBase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for TransactionBase

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

Serialize this value into the given Serde serializer.