Package com.plaid.client.model

Class Transaction

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-03-31T09:49:55.055Z[GMT]")
public class Transaction
extends Object
    A representation of a transaction

    • Constructor Detail

      • Transaction

        public Transaction()

    • Method Detail

      • getTransactionType

        @Nullable
public Transaction.TransactionTypeEnum getTransactionType()
        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.
        Returns:
        transactionType

      • getTransactionId

        public String getTransactionId()
        The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive.
        Returns:
        transactionId

      • setTransactionId

        public void setTransactionId​(String transactionId)

      • getAccountOwner

        @Nullable
public String getAccountOwner()
        The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
        Returns:
        accountOwner

      • setAccountOwner

        public void setAccountOwner​(String accountOwner)

      • pendingTransactionId

        public Transaction pendingTransactionId​(String pendingTransactionId)

      • getPendingTransactionId

        @Nullable
public String getPendingTransactionId()
        The ID of a posted transaction's associated pending transaction, where applicable.
        Returns:
        pendingTransactionId

      • setPendingTransactionId

        public void setPendingTransactionId​(String pendingTransactionId)

      • getPending

        public Boolean getPending()
        When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
        Returns:
        pending

      • setPending

        public void setPending​(Boolean pending)

      • getPaymentChannel

        @Nullable
public Transaction.PaymentChannelEnum getPaymentChannel()
        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. This field replaces the `transaction_type` field.
        Returns:
        paymentChannel

      • getPaymentMeta

        @Nullable
public PaymentMeta getPaymentMeta()
        Get paymentMeta
        Returns:
        paymentMeta

      • setPaymentMeta

        public void setPaymentMeta​(PaymentMeta paymentMeta)

      • getName

        @Nullable
public String getName()
        The merchant name or transaction description. If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transaction` 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.
        Returns:
        name

      • setName

        public void setName​(String name)

      • getMerchantName

        @Nullable
public String getMerchantName()
        The merchant name, as extracted by Plaid from the `name` field.
        Returns:
        merchantName

      • setMerchantName

        public void setMerchantName​(String merchantName)

      • getLocation

        @Nullable
public Location getLocation()
        Get location
        Returns:
        location

      • setLocation

        public void setLocation​(Location location)

      • getAuthorizedDate

        @Nullable
public String getAuthorizedDate()
        The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ).
        Returns:
        authorizedDate

      • setAuthorizedDate

        public void setAuthorizedDate​(String authorizedDate)

      • authorizedDatetime

        public Transaction authorizedDatetime​(String authorizedDatetime)

      • getAuthorizedDatetime

        @Nullable
public String getAuthorizedDatetime()
        Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`.
        Returns:
        authorizedDatetime

      • setAuthorizedDatetime

        public void setAuthorizedDatetime​(String authorizedDatetime)

      • getDate

        public String getDate()
        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` ).
        Returns:
        date

      • setDate

        public void setDate​(String date)

      • getDatetime

        @Nullable
public String getDatetime()
        Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`.
        Returns:
        datetime

      • setDatetime

        public void setDatetime​(String datetime)

      • getCategoryId

        @Nullable
public String getCategoryId()
        The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` 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.
        Returns:
        categoryId

      • setCategoryId

        public void setCategoryId​(String categoryId)

      • getCategory

        @Nullable
public List<String> getCategory()
        A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` 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.
        Returns:
        category

      • setCategory

        public void setCategory​(List<String> category)

      • unofficialCurrencyCode

        public Transaction unofficialCurrencyCode​(String unofficialCurrencyCode)

      • getUnofficialCurrencyCode

        @Nullable
public String getUnofficialCurrencyCode()
        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](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
        Returns:
        unofficialCurrencyCode

      • setUnofficialCurrencyCode

        public void setUnofficialCurrencyCode​(String unofficialCurrencyCode)

      • getIsoCurrencyCode

        @Nullable
public String getIsoCurrencyCode()
        The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null.
        Returns:
        isoCurrencyCode

      • setIsoCurrencyCode

        public void setIsoCurrencyCode​(String isoCurrencyCode)

      • getAmount

        public Double getAmount()
        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.
        Returns:
        amount

      • setAmount

        public void setAmount​(Double amount)

      • getAccountId

        public String getAccountId()
        The ID of the account in which this transaction occurred.
        Returns:
        accountId

      • setAccountId

        public void setAccountId​(String accountId)

      • getTransactionCode

        @Nullable
public TransactionCode getTransactionCode()
        Get transactionCode
        Returns:
        transactionCode

      • setTransactionCode

        public void setTransactionCode​(TransactionCode transactionCode)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object