TransactionBase (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.TransactionBase

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class TransactionBase
extends Object

A representation of a transaction

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TransactionBase.TransactionTypeEnum` Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_ACCOUNT_OWNER`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CATEGORY`
`static String`	`SERIALIZED_NAME_CATEGORY_ID`
`static String`	`SERIALIZED_NAME_CHECK_NUMBER`
`static String`	`SERIALIZED_NAME_DATE`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_LOCATION`
`static String`	`SERIALIZED_NAME_LOGO_URL`
`static String`	`SERIALIZED_NAME_MERCHANT_NAME`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_ORIGINAL_DESCRIPTION`
`static String`	`SERIALIZED_NAME_PAYMENT_META`
`static String`	`SERIALIZED_NAME_PENDING`
`static String`	`SERIALIZED_NAME_PENDING_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_TRANSACTION_ID`
`static String`	`SERIALIZED_NAME_TRANSACTION_TYPE`
`static String`	`SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_WEBSITE`

Constructor Summary

Constructors
Constructor and Description

TransactionBase()

Constructors
Constructor and Description
`TransactionBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransactionBase`	`accountId(String accountId)`
`TransactionBase`	`accountOwner(String accountOwner)`
`TransactionBase`	`addCategoryItem(String categoryItem)`
`TransactionBase`	`amount(Double amount)`
`TransactionBase`	`category(List<String> category)`
`TransactionBase`	`categoryId(String categoryId)`
`TransactionBase`	`checkNumber(String checkNumber)`
`TransactionBase`	`date(LocalDate date)`
`boolean`	`equals(Object o)`
`String`	`getAccountId()` The ID of the account in which this transaction occurred.
`String`	`getAccountOwner()` The name of the account owner.
`Double`	`getAmount()` The settled value of the transaction, denominated in the transactions's currency, as stated in `iso_currency_code` or `unofficial_currency_code`.
`List<String>`	`getCategory()` A hierarchical array of the categories to which this transaction belongs.
`String`	`getCategoryId()` The ID of the category to which this transaction belongs.
`String`	`getCheckNumber()` The check number of the transaction.
`LocalDate`	`getDate()` For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted.
`String`	`getIsoCurrencyCode()` The ISO-4217 currency code of the transaction.
`Location`	`getLocation()` Get location
`String`	`getLogoUrl()` The URL of a logo associated with this transaction, if available.
`String`	`getMerchantName()` The merchant name, as enriched by Plaid from the `name` field.
`String`	`getName()` The merchant name or transaction description.
`String`	`getOriginalDescription()` The string returned by the financial institution to describe the transaction.
`PaymentMeta`	`getPaymentMeta()` Get paymentMeta
`Boolean`	`getPending()` When `true`, identifies the transaction as pending or unsettled.
`String`	`getPendingTransactionId()` The ID of a posted transaction's associated pending transaction, where applicable.
`String`	`getTransactionId()` The unique ID of the transaction.
`TransactionBase.TransactionTypeEnum`	`getTransactionType()` Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.
`String`	`getUnofficialCurrencyCode()` The unofficial currency code associated with the transaction.
`String`	`getWebsite()` The website associated with this transaction, if available.
`int`	`hashCode()`
`TransactionBase`	`isoCurrencyCode(String isoCurrencyCode)`
`TransactionBase`	`location(Location location)`
`TransactionBase`	`logoUrl(String logoUrl)`
`TransactionBase`	`merchantName(String merchantName)`
`TransactionBase`	`name(String name)`
`TransactionBase`	`originalDescription(String originalDescription)`
`TransactionBase`	`paymentMeta(PaymentMeta paymentMeta)`
`TransactionBase`	`pending(Boolean pending)`
`TransactionBase`	`pendingTransactionId(String pendingTransactionId)`
`void`	`setAccountId(String accountId)`
`void`	`setAccountOwner(String accountOwner)`
`void`	`setAmount(Double amount)`
`void`	`setCategory(List<String> category)`
`void`	`setCategoryId(String categoryId)`
`void`	`setCheckNumber(String checkNumber)`
`void`	`setDate(LocalDate date)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setLocation(Location location)`
`void`	`setLogoUrl(String logoUrl)`
`void`	`setMerchantName(String merchantName)`
`void`	`setName(String name)`
`void`	`setOriginalDescription(String originalDescription)`
`void`	`setPaymentMeta(PaymentMeta paymentMeta)`
`void`	`setPending(Boolean pending)`
`void`	`setPendingTransactionId(String pendingTransactionId)`
`void`	`setTransactionId(String transactionId)`
`void`	`setTransactionType(TransactionBase.TransactionTypeEnum transactionType)`
`void`	`setUnofficialCurrencyCode(String unofficialCurrencyCode)`
`void`	`setWebsite(String website)`
`String`	`toString()`
`TransactionBase`	`transactionId(String transactionId)`
`TransactionBase`	`transactionType(TransactionBase.TransactionTypeEnum transactionType)`
`TransactionBase`	`unofficialCurrencyCode(String unofficialCurrencyCode)`
`TransactionBase`	`website(String website)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AMOUNT
```
public static final String SERIALIZED_NAME_AMOUNT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ISO_CURRENCY_CODE
```
public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE
```
public static final String SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CATEGORY
```
public static final String SERIALIZED_NAME_CATEGORY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CATEGORY_ID
```
public static final String SERIALIZED_NAME_CATEGORY_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CHECK_NUMBER
```
public static final String SERIALIZED_NAME_CHECK_NUMBER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DATE
```
public static final String SERIALIZED_NAME_DATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOCATION
```
public static final String SERIALIZED_NAME_LOCATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MERCHANT_NAME
```
public static final String SERIALIZED_NAME_MERCHANT_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ORIGINAL_DESCRIPTION
```
public static final String SERIALIZED_NAME_ORIGINAL_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAYMENT_META
```
public static final String SERIALIZED_NAME_PAYMENT_META
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PENDING
```
public static final String SERIALIZED_NAME_PENDING
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PENDING_TRANSACTION_ID
```
public static final String SERIALIZED_NAME_PENDING_TRANSACTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_OWNER
```
public static final String SERIALIZED_NAME_ACCOUNT_OWNER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSACTION_ID
```
public static final String SERIALIZED_NAME_TRANSACTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSACTION_TYPE
```
public static final String SERIALIZED_NAME_TRANSACTION_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOGO_URL
```
public static final String SERIALIZED_NAME_LOGO_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WEBSITE
```
public static final String SERIALIZED_NAME_WEBSITE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransactionBase
```
public TransactionBase()
```
- Method Detail
  - accountId
```
public TransactionBase accountId(String accountId)
```
  - getAccountId
```
public String getAccountId()
```
    The ID of the account in which this transaction occurred.
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(String accountId)
```
  - amount
```
public TransactionBase amount(Double amount)
```
  - getAmount
```
public Double getAmount()
```
    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.
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Double amount)
```
  - isoCurrencyCode
```
public TransactionBase isoCurrencyCode(String isoCurrencyCode)
```
  - 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)
```
  - unofficialCurrencyCode
```
public TransactionBase 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](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(String unofficialCurrencyCode)
```
  - category
```
public TransactionBase category(List<String> category)
```
  - addCategoryItem
```
public TransactionBase addCategoryItem(String categoryItem)
```
  - getCategory
```
@Nullable
public List<String> getCategory()
```
    A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget). All Transactions implementations are recommended to use the new `personal_finance_category` instead of `category`, as it provides greater accuracy and more meaningful categorization. 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(List<String> category)
```
  - categoryId
```
public TransactionBase categoryId(String categoryId)
```
  - getCategoryId
```
@Nullable
public String getCategoryId()
```
    The ID of the category to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget). All Transactions implementations are recommended to use the new `personal_finance_category` instead of `category`, as it provides greater accuracy and more meaningful categorization. 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(String categoryId)
```
  - checkNumber
```
public TransactionBase checkNumber(String checkNumber)
```
  - getCheckNumber
```
@Nullable
public String getCheckNumber()
```
    The check number of the transaction. This field is only populated for check transactions.
    
    Returns:
    
    checkNumber
  - setCheckNumber
```
public void setCheckNumber(String checkNumber)
```
  - date
```
public TransactionBase date(LocalDate date)
```
  - getDate
```
public 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` ). To receive information about the date that a posted transaction was initiated, see the `authorized_date` field.
    
    Returns:
    
    date
  - setDate
```
public void setDate(LocalDate date)
```
  - location
```
public TransactionBase location(Location location)
```
  - getLocation
```
@Nullable
public Location getLocation()
```
    Get location
    
    Returns:
    
    location
  - setLocation
```
public void setLocation(Location location)
```
  - name
```
public TransactionBase name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    The merchant name or transaction description. If the `transactions` object was returned by a Transactions endpoint such as `/transactions/sync` or `/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(String name)
```
  - merchantName
```
public TransactionBase merchantName(String merchantName)
```
  - getMerchantName
```
@Nullable
public String getMerchantName()
```
    The merchant name, as enriched by Plaid from the `name` field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be `null`.
    
    Returns:
    
    merchantName
  - setMerchantName
```
public void setMerchantName(String merchantName)
```
  - originalDescription
```
public TransactionBase originalDescription(String originalDescription)
```
  - getOriginalDescription
```
@Nullable
public String getOriginalDescription()
```
    The string returned by the financial institution to describe the transaction. For transactions returned by `/transactions/sync` or `/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(String originalDescription)
```
  - paymentMeta
```
public TransactionBase paymentMeta(PaymentMeta paymentMeta)
```
  - getPaymentMeta
```
@Nullable
public PaymentMeta getPaymentMeta()
```
    Get paymentMeta
    
    Returns:
    
    paymentMeta
  - setPaymentMeta
```
public void setPaymentMeta(PaymentMeta paymentMeta)
```
  - pending
```
public TransactionBase pending(Boolean pending)
```
  - 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)
```
  - pendingTransactionId
```
public TransactionBase 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)
```
  - accountOwner
```
public TransactionBase accountOwner(String accountOwner)
```
  - 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)
```
  - transactionId
```
public TransactionBase transactionId(String transactionId)
```
  - 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)
```
  - 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)
```
  - logoUrl
```
public TransactionBase logoUrl(String logoUrl)
```
  - getLogoUrl
```
@Nullable
public String getLogoUrl()
```
    The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.
    
    Returns:
    
    logoUrl
  - setLogoUrl
```
public void setLogoUrl(String logoUrl)
```
  - website
```
public TransactionBase website(String website)
```
  - getWebsite
```
@Nullable
public String getWebsite()
```
    The website associated with this transaction, if available.
    
    Returns:
    
    website
  - setWebsite
```
public void setWebsite(String website)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TransactionBase

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE

SERIALIZED_NAME_CATEGORY

SERIALIZED_NAME_CATEGORY_ID

SERIALIZED_NAME_CHECK_NUMBER

SERIALIZED_NAME_DATE

SERIALIZED_NAME_LOCATION

SERIALIZED_NAME_NAME

SERIALIZED_NAME_MERCHANT_NAME

SERIALIZED_NAME_ORIGINAL_DESCRIPTION

SERIALIZED_NAME_PAYMENT_META

SERIALIZED_NAME_PENDING

SERIALIZED_NAME_PENDING_TRANSACTION_ID

SERIALIZED_NAME_ACCOUNT_OWNER

SERIALIZED_NAME_TRANSACTION_ID

SERIALIZED_NAME_TRANSACTION_TYPE

SERIALIZED_NAME_LOGO_URL

SERIALIZED_NAME_WEBSITE

Constructor Detail

TransactionBase

Method Detail

accountId

getAccountId

setAccountId

amount

getAmount

setAmount

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

unofficialCurrencyCode

getUnofficialCurrencyCode

setUnofficialCurrencyCode

category

addCategoryItem

getCategory

setCategory

categoryId

getCategoryId

setCategoryId

checkNumber

getCheckNumber

setCheckNumber

date

getDate

setDate

location

getLocation

setLocation

name

getName

setName

merchantName

getMerchantName

setMerchantName

originalDescription

getOriginalDescription

setOriginalDescription

paymentMeta

getPaymentMeta

setPaymentMeta

pending

getPending

setPending

pendingTransactionId

getPendingTransactionId

setPendingTransactionId

accountOwner

getAccountOwner

setAccountOwner

transactionId