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

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

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

The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CONFIDENCE_LEVEL`
`static String`	`SERIALIZED_NAME_ENTITY_ID`
`static String`	`SERIALIZED_NAME_LOGO_URL`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_WEBSITE`

Constructor Summary

Constructors
Constructor and Description

TransactionCounterparty()

Constructors
Constructor and Description
`TransactionCounterparty()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransactionCounterparty`	`confidenceLevel(String confidenceLevel)`
`TransactionCounterparty`	`entityId(String entityId)`
`boolean`	`equals(Object o)`
`String`	`getConfidenceLevel()` A description of how confident we are that the provided counterparty is involved in the transaction.
`String`	`getEntityId()` A unique, stable, Plaid-generated ID that maps to the counterparty.
`String`	`getLogoUrl()` The URL of a logo associated with the counterparty, if available.
`String`	`getName()` The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.
`CounterpartyType`	`getType()` Get type
`String`	`getWebsite()` The website associated with the counterparty.
`int`	`hashCode()`
`TransactionCounterparty`	`logoUrl(String logoUrl)`
`TransactionCounterparty`	`name(String name)`
`void`	`setConfidenceLevel(String confidenceLevel)`
`void`	`setEntityId(String entityId)`
`void`	`setLogoUrl(String logoUrl)`
`void`	`setName(String name)`
`void`	`setType(CounterpartyType type)`
`void`	`setWebsite(String website)`
`String`	`toString()`
`TransactionCounterparty`	`type(CounterpartyType type)`
`TransactionCounterparty`	`website(String website)`

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

- Field Detail
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ENTITY_ID
```
public static final String SERIALIZED_NAME_ENTITY_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WEBSITE
```
public static final String SERIALIZED_NAME_WEBSITE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOGO_URL
```
public static final String SERIALIZED_NAME_LOGO_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CONFIDENCE_LEVEL
```
public static final String SERIALIZED_NAME_CONFIDENCE_LEVEL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransactionCounterparty
```
public TransactionCounterparty()
```
- Method Detail
  - name
```
public TransactionCounterparty name(String name)
```
  - getName
```
public String getName()
```
    The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - entityId
```
public TransactionCounterparty entityId(String entityId)
```
  - getEntityId
```
@Nullable
public String getEntityId()
```
    A unique, stable, Plaid-generated ID that maps to the counterparty.
    
    Returns:
    
    entityId
  - setEntityId
```
public void setEntityId(String entityId)
```
  - type
```
public TransactionCounterparty type(CounterpartyType type)
```
  - getType
```
public CounterpartyType getType()
```
    Get type
    
    Returns:
    
    type
  - setType
```
public void setType(CounterpartyType type)
```
  - website
```
public TransactionCounterparty website(String website)
```
  - getWebsite
```
@Nullable
public String getWebsite()
```
    The website associated with the counterparty.
    
    Returns:
    
    website
  - setWebsite
```
public void setWebsite(String website)
```
  - logoUrl
```
public TransactionCounterparty logoUrl(String logoUrl)
```
  - getLogoUrl
```
@Nullable
public String getLogoUrl()
```
    The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.
    
    Returns:
    
    logoUrl
  - setLogoUrl
```
public void setLogoUrl(String logoUrl)
```
  - confidenceLevel
```
public TransactionCounterparty confidenceLevel(String confidenceLevel)
```
  - getConfidenceLevel
```
@Nullable
public String getConfidenceLevel()
```
    A description of how confident we are that the provided counterparty is involved in the transaction. `VERY_HIGH`: We recognize this counterparty and we are more than 98% confident that it is involved in this transaction. `HIGH`: We recognize this counterparty and we are more than 90% confident that it is involved in this transaction. `MEDIUM`: We are moderately confident that this counterparty was involved in this transaction, but some details may differ from our records. `LOW`: We didn’t find a matching counterparty in our records, so we are returning a cleansed name parsed out of the request description. `UNKNOWN`: We don’t know the confidence level for this counterparty.
    
    Returns:
    
    confidenceLevel
  - setConfidenceLevel
```
public void setConfidenceLevel(String confidenceLevel)
```
  - 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 TransactionCounterparty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_NAME

SERIALIZED_NAME_ENTITY_ID

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_WEBSITE

SERIALIZED_NAME_LOGO_URL

SERIALIZED_NAME_CONFIDENCE_LEVEL

Constructor Detail

TransactionCounterparty

Method Detail

name

getName

setName

entityId

getEntityId

setEntityId

type

getType

setType

website

getWebsite

setWebsite

logoUrl

getLogoUrl

setLogoUrl

confidenceLevel

getConfidenceLevel

setConfidenceLevel

equals

hashCode

toString