Package com.plaid.client.model

Class TransactionBase

java.lang.Object
com.plaid.client.model.TransactionBase
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class TransactionBase
extends java.lang.Object
A representation of a transaction

  • Field Details

  • Constructor Details

  • Method Details

    • transactionType

      public TransactionBase transactionType​(TransactionBase.TransactionTypeEnum transactionType)

    • getTransactionType

      @Nullable public TransactionBase.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

    • setTransactionType

      public void setTransactionType​(TransactionBase.TransactionTypeEnum transactionType)

    • pendingTransactionId

      public TransactionBase pendingTransactionId​(java.lang.String pendingTransactionId)

    • getPendingTransactionId

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

    • setPendingTransactionId

      public void setPendingTransactionId​(java.lang.String pendingTransactionId)

    • categoryId

      public TransactionBase categoryId​(java.lang.String categoryId)

    • getCategoryId

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

    • setCategoryId

      public void setCategoryId​(java.lang.String categoryId)

    • category

      public TransactionBase category​(java.util.List<java.lang.String> category)

    • addCategoryItem

      public TransactionBase addCategoryItem​(java.lang.String categoryItem)

    • getCategory

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

    • setCategory

      public void setCategory​(java.util.List<java.lang.String> category)

    • location

      public TransactionBase location​(Location location)

    • getLocation

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

    • setLocation

      public void setLocation​(Location location)

    • paymentMeta

      public TransactionBase paymentMeta​(PaymentMeta paymentMeta)

    • getPaymentMeta

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

    • setPaymentMeta

      public void setPaymentMeta​(PaymentMeta paymentMeta)

    • accountOwner

      public TransactionBase accountOwner​(java.lang.String accountOwner)

    • getAccountOwner

      @Nullable public java.lang.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​(java.lang.String accountOwner)

    • name

      public TransactionBase name​(java.lang.String name)

    • getName

      @Nullable public java.lang.String getName()
      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.
      Returns:
      name

    • setName

      public void setName​(java.lang.String name)

    • originalDescription

      public TransactionBase originalDescription​(java.lang.String originalDescription)

    • getOriginalDescription

      @Nullable public java.lang.String getOriginalDescription()
      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`.
      Returns:
      originalDescription

    • setOriginalDescription

      public void setOriginalDescription​(java.lang.String originalDescription)

    • accountId

      public TransactionBase accountId​(java.lang.String accountId)

    • getAccountId

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

    • setAccountId

      public void setAccountId​(java.lang.String accountId)

    • amount

      public TransactionBase amount​(java.lang.Double amount)

    • getAmount

      public java.lang.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​(java.lang.Double amount)

    • isoCurrencyCode

      public TransactionBase isoCurrencyCode​(java.lang.String isoCurrencyCode)

    • getIsoCurrencyCode

      @Nullable public java.lang.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​(java.lang.String isoCurrencyCode)

    • unofficialCurrencyCode

      public TransactionBase unofficialCurrencyCode​(java.lang.String unofficialCurrencyCode)

    • getUnofficialCurrencyCode

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

    • setUnofficialCurrencyCode

      public void setUnofficialCurrencyCode​(java.lang.String unofficialCurrencyCode)

    • date

      public TransactionBase date​(java.time.LocalDate date)

    • getDate

      public java.time.LocalDate 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](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
      Returns:
      date

    • setDate

      public void setDate​(java.time.LocalDate date)

    • pending

      public TransactionBase pending​(java.lang.Boolean pending)

    • getPending

      public java.lang.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​(java.lang.Boolean pending)

    • transactionId

      public TransactionBase transactionId​(java.lang.String transactionId)

    • getTransactionId

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

    • setTransactionId

      public void setTransactionId​(java.lang.String transactionId)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object