com.plaid.client.model

Class TransferEventListRequest

java.lang.Object

com.plaid.client.model.TransferEventListRequest

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

Defines the request schema for `/transfer/event/list`

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_ID
static String	SERIALIZED_NAME_CLIENT_ID
static String	SERIALIZED_NAME_COUNT
static String	SERIALIZED_NAME_END_DATE
static String	SERIALIZED_NAME_EVENT_TYPES
static String	SERIALIZED_NAME_FUNDING_ACCOUNT_ID
static String	SERIALIZED_NAME_OFFSET
static String	SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
static String	SERIALIZED_NAME_ORIGINATOR_CLIENT_ID
static String	SERIALIZED_NAME_SECRET
static String	SERIALIZED_NAME_START_DATE
static String	SERIALIZED_NAME_SWEEP_ID
static String	SERIALIZED_NAME_TRANSFER_ID
static String	SERIALIZED_NAME_TRANSFER_TYPE

Constructor Summary

Constructors

Constructor and Description
TransferEventListRequest()

Method Summary

Modifier and Type	Method and Description
TransferEventListRequest	accountId(String accountId)
TransferEventListRequest	addEventTypesItem(TransferEventType eventTypesItem)
TransferEventListRequest	clientId(String clientId)
TransferEventListRequest	count(Integer count)
TransferEventListRequest	endDate(OffsetDateTime endDate)
boolean	equals(Object o)
TransferEventListRequest	eventTypes(List<TransferEventType> eventTypes)
TransferEventListRequest	fundingAccountId(String fundingAccountId)
String	getAccountId() The account ID to get events for all transactions to/from an account.
String	getClientId() Your Plaid API `client_id`.
Integer	getCount() The maximum number of transfer events to return.
OffsetDateTime	getEndDate() The end datetime of transfers to list.
List<TransferEventType>	getEventTypes() Filter events by event type.
String	getFundingAccountId() Filter transfer events to only those with the specified `funding_account_id`.
Integer	getOffset() The offset into the list of transfer events.
String	getOriginationAccountId() The origination account ID to get events for transfers from a specific origination account.
String	getOriginatorClientId() Filter transfer events to only those with the specified originator client.
String	getSecret() Your Plaid API `secret`.
OffsetDateTime	getStartDate() The start datetime of transfers to list.
String	getSweepId() Plaid’s unique identifier for a sweep.
String	getTransferId() Plaid’s unique identifier for a transfer.
TransferEventListTransferType	getTransferType() Get transferType
int	hashCode()
TransferEventListRequest	offset(Integer offset)
TransferEventListRequest	originationAccountId(String originationAccountId)
TransferEventListRequest	originatorClientId(String originatorClientId)
TransferEventListRequest	secret(String secret)
void	setAccountId(String accountId)
void	setClientId(String clientId)
void	setCount(Integer count)
void	setEndDate(OffsetDateTime endDate)
void	setEventTypes(List<TransferEventType> eventTypes)
void	setFundingAccountId(String fundingAccountId)
void	setOffset(Integer offset)
void	setOriginationAccountId(String originationAccountId)
void	setOriginatorClientId(String originatorClientId)
void	setSecret(String secret)
void	setStartDate(OffsetDateTime startDate)
void	setSweepId(String sweepId)
void	setTransferId(String transferId)
void	setTransferType(TransferEventListTransferType transferType)
TransferEventListRequest	startDate(OffsetDateTime startDate)
TransferEventListRequest	sweepId(String sweepId)
String	toString()
TransferEventListRequest	transferId(String transferId)
TransferEventListRequest	transferType(TransferEventListTransferType transferType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_CLIENT_ID

public static final String SERIALIZED_NAME_CLIENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SECRET

public static final String SERIALIZED_NAME_SECRET

See Also:

Constant Field Values

SERIALIZED_NAME_START_DATE

public static final String SERIALIZED_NAME_START_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_END_DATE

public static final String SERIALIZED_NAME_END_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFER_ID

public static final String SERIALIZED_NAME_TRANSFER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_ID

public static final String SERIALIZED_NAME_ACCOUNT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFER_TYPE

public static final String SERIALIZED_NAME_TRANSFER_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_EVENT_TYPES

public static final String SERIALIZED_NAME_EVENT_TYPES

See Also:

Constant Field Values

SERIALIZED_NAME_SWEEP_ID

public static final String SERIALIZED_NAME_SWEEP_ID

See Also:

Constant Field Values

SERIALIZED_NAME_COUNT

public static final String SERIALIZED_NAME_COUNT

See Also:

Constant Field Values

SERIALIZED_NAME_OFFSET

public static final String SERIALIZED_NAME_OFFSET

See Also:

Constant Field Values

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

public static final String SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ORIGINATOR_CLIENT_ID

public static final String SERIALIZED_NAME_ORIGINATOR_CLIENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_FUNDING_ACCOUNT_ID

public static final String SERIALIZED_NAME_FUNDING_ACCOUNT_ID

See Also:

Constant Field Values

Constructor Detail

TransferEventListRequest

public TransferEventListRequest()

Method Detail

clientId

public TransferEventListRequest clientId(String clientId)

getClientId

@Nullable
public String getClientId()

Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

clientId

setClientId

public void setClientId(String clientId)

secret

public TransferEventListRequest secret(String secret)

getSecret

@Nullable
public String getSecret()

Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

secret

setSecret

public void setSecret(String secret)

startDate

public TransferEventListRequest startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

endDate

public TransferEventListRequest endDate(OffsetDateTime endDate)

getEndDate

@Nullable
public OffsetDateTime getEndDate()

The end datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)

Returns:

endDate

setEndDate

public void setEndDate(OffsetDateTime endDate)

transferId

public TransferEventListRequest transferId(String transferId)

getTransferId

@Nullable
public String getTransferId()

Plaid’s unique identifier for a transfer.

Returns:

transferId

setTransferId

public void setTransferId(String transferId)

accountId

public TransferEventListRequest accountId(String accountId)

getAccountId

@Nullable
public String getAccountId()

The account ID to get events for all transactions to/from an account.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

transferType

public TransferEventListRequest transferType(TransferEventListTransferType transferType)

getTransferType

@Nullable
public TransferEventListTransferType getTransferType()

Get transferType

Returns:

transferType

setTransferType

public void setTransferType(TransferEventListTransferType transferType)

eventTypes

public TransferEventListRequest eventTypes(List<TransferEventType> eventTypes)

addEventTypesItem

public TransferEventListRequest addEventTypesItem(TransferEventType eventTypesItem)

getEventTypes

@Nullable
public List<TransferEventType> getEventTypes()

Filter events by event type.

Returns:

eventTypes

setEventTypes

public void setEventTypes(List<TransferEventType> eventTypes)

sweepId

public TransferEventListRequest sweepId(String sweepId)

getSweepId

@Nullable
public String getSweepId()

Plaid’s unique identifier for a sweep.

Returns:

sweepId

setSweepId

public void setSweepId(String sweepId)

count

public TransferEventListRequest count(Integer count)

getCount

@Nullable
public Integer getCount()

The maximum number of transfer events to return. If the number of events matching the above parameters is greater than `count`, the most recent events will be returned. minimum: 1 maximum: 25

Returns:

count

setCount

public void setCount(Integer count)

offset

public TransferEventListRequest offset(Integer offset)

getOffset

@Nullable
public Integer getOffset()

The offset into the list of transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 events will be returned. minimum: 0

Returns:

offset

setOffset

public void setOffset(Integer offset)

originationAccountId

public TransferEventListRequest originationAccountId(String originationAccountId)

getOriginationAccountId

@Nullable
public String getOriginationAccountId()

The origination account ID to get events for transfers from a specific origination account.

Returns:

originationAccountId

setOriginationAccountId

public void setOriginationAccountId(String originationAccountId)

originatorClientId

public TransferEventListRequest originatorClientId(String originatorClientId)

getOriginatorClientId

@Nullable
public String getOriginatorClientId()

Filter transfer events to only those with the specified originator client.

Returns:

originatorClientId

setOriginatorClientId

public void setOriginatorClientId(String originatorClientId)

fundingAccountId

public TransferEventListRequest fundingAccountId(String fundingAccountId)

getFundingAccountId

@Nullable
public String getFundingAccountId()

Filter transfer events to only those with the specified `funding_account_id`.

Returns:

fundingAccountId

setFundingAccountId

public void setFundingAccountId(String fundingAccountId)

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