com.plaid.client.model

Class TransferEvent

java.lang.Object

com.plaid.client.model.TransferEvent

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

Represents an event in the Transfers API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_ID
static String	SERIALIZED_NAME_EVENT_ID
static String	SERIALIZED_NAME_EVENT_TYPE
static String	SERIALIZED_NAME_FAILURE_REASON
static String	SERIALIZED_NAME_FUNDING_ACCOUNT_ID
static String	SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
static String	SERIALIZED_NAME_ORIGINATOR_CLIENT_ID
static String	SERIALIZED_NAME_REFUND_ID
static String	SERIALIZED_NAME_SWEEP_AMOUNT
static String	SERIALIZED_NAME_SWEEP_ID
static String	SERIALIZED_NAME_TIMESTAMP
static String	SERIALIZED_NAME_TRANSFER_AMOUNT
static String	SERIALIZED_NAME_TRANSFER_ID
static String	SERIALIZED_NAME_TRANSFER_TYPE

Constructor Summary

Constructors

Constructor and Description
TransferEvent()

Method Summary

Modifier and Type	Method and Description
TransferEvent	accountId(String accountId)
boolean	equals(Object o)
TransferEvent	eventId(Integer eventId)
TransferEvent	eventType(TransferEventType eventType)
TransferEvent	failureReason(TransferFailure failureReason)
TransferEvent	fundingAccountId(String fundingAccountId)
String	getAccountId() The account ID associated with the transfer.
Integer	getEventId() Plaid’s unique identifier for this event.
TransferEventType	getEventType() Get eventType
TransferFailure	getFailureReason() Get failureReason
String	getFundingAccountId() The id of the associated funding account, available in the Plaid Dashboard.
String	getOriginationAccountId() The ID of the origination account that this balance belongs to.
String	getOriginatorClientId() The Plaid client ID that is the originator of the transfer that this event applies to.
String	getRefundId() Plaid’s unique identifier for a refund.
String	getSweepAmount() A signed amount of how much was `swept` or `return_swept` for this transfer (decimal string with two digits of precision e.g.
String	getSweepId() Plaid’s unique identifier for a sweep.
OffsetDateTime	getTimestamp() The datetime when this event occurred.
String	getTransferAmount() The amount of the transfer (decimal string with two digits of precision e.g.
String	getTransferId() Plaid’s unique identifier for a transfer.
OmittableTransferType	getTransferType() Get transferType
int	hashCode()
TransferEvent	originationAccountId(String originationAccountId)
TransferEvent	originatorClientId(String originatorClientId)
TransferEvent	refundId(String refundId)
void	setAccountId(String accountId)
void	setEventId(Integer eventId)
void	setEventType(TransferEventType eventType)
void	setFailureReason(TransferFailure failureReason)
void	setFundingAccountId(String fundingAccountId)
void	setOriginationAccountId(String originationAccountId)
void	setOriginatorClientId(String originatorClientId)
void	setRefundId(String refundId)
void	setSweepAmount(String sweepAmount)
void	setSweepId(String sweepId)
void	setTimestamp(OffsetDateTime timestamp)
void	setTransferAmount(String transferAmount)
void	setTransferId(String transferId)
void	setTransferType(OmittableTransferType transferType)
TransferEvent	sweepAmount(String sweepAmount)
TransferEvent	sweepId(String sweepId)
TransferEvent	timestamp(OffsetDateTime timestamp)
String	toString()
TransferEvent	transferAmount(String transferAmount)
TransferEvent	transferId(String transferId)
TransferEvent	transferType(OmittableTransferType transferType)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_EVENT_ID

public static final String SERIALIZED_NAME_EVENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TIMESTAMP

public static final String SERIALIZED_NAME_TIMESTAMP

See Also:

Constant Field Values

SERIALIZED_NAME_EVENT_TYPE

public static final String SERIALIZED_NAME_EVENT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_ID

public static final String SERIALIZED_NAME_ACCOUNT_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

SERIALIZED_NAME_TRANSFER_ID

public static final String SERIALIZED_NAME_TRANSFER_ID

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_TRANSFER_TYPE

public static final String SERIALIZED_NAME_TRANSFER_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFER_AMOUNT

public static final String SERIALIZED_NAME_TRANSFER_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_FAILURE_REASON

public static final String SERIALIZED_NAME_FAILURE_REASON

See Also:

Constant Field Values

SERIALIZED_NAME_SWEEP_ID

public static final String SERIALIZED_NAME_SWEEP_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SWEEP_AMOUNT

public static final String SERIALIZED_NAME_SWEEP_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_REFUND_ID

public static final String SERIALIZED_NAME_REFUND_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

Constructor Detail

TransferEvent

public TransferEvent()

Method Detail

eventId

public TransferEvent eventId(Integer eventId)

getEventId

public Integer getEventId()

Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers. minimum: 0

Returns:

eventId

setEventId

public void setEventId(Integer eventId)

timestamp

public TransferEvent timestamp(OffsetDateTime timestamp)

getTimestamp

public OffsetDateTime getTimestamp()

The datetime when this event occurred. This will be of the form `2006-01-02T15:04:05Z`.

Returns:

timestamp

setTimestamp

public void setTimestamp(OffsetDateTime timestamp)

eventType

public TransferEvent eventType(TransferEventType eventType)

getEventType

public TransferEventType getEventType()

Get eventType

Returns:

eventType

setEventType

public void setEventType(TransferEventType eventType)

accountId

public TransferEvent accountId(String accountId)

getAccountId

@Nullable
public String getAccountId()

The account ID associated with the transfer. This field is omitted for Plaid Ledger Sweep events.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

fundingAccountId

public TransferEvent fundingAccountId(String fundingAccountId)

getFundingAccountId

@Nullable
public String getFundingAccountId()

The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.

Returns:

fundingAccountId

setFundingAccountId

public void setFundingAccountId(String fundingAccountId)

transferId

public TransferEvent transferId(String transferId)

getTransferId

public String getTransferId()

Plaid’s unique identifier for a transfer. This field is `null` for Plaid Ledger Sweep events.

Returns:

transferId

setTransferId

public void setTransferId(String transferId)

originationAccountId

public TransferEvent originationAccountId(String originationAccountId)

getOriginationAccountId

@Nullable
public String getOriginationAccountId()

The ID of the origination account that this balance belongs to.

Returns:

originationAccountId

setOriginationAccountId

public void setOriginationAccountId(String originationAccountId)

transferType

public TransferEvent transferType(OmittableTransferType transferType)

getTransferType

@Nullable
public OmittableTransferType getTransferType()

Get transferType

Returns:

transferType

setTransferType

public void setTransferType(OmittableTransferType transferType)

transferAmount

public TransferEvent transferAmount(String transferAmount)

getTransferAmount

@Nullable
public String getTransferAmount()

The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\"). This field is omitted for Plaid Ledger Sweep events.

Returns:

transferAmount

setTransferAmount

public void setTransferAmount(String transferAmount)

failureReason

public TransferEvent failureReason(TransferFailure failureReason)

getFailureReason

@Nullable
public TransferFailure getFailureReason()

Get failureReason

Returns:

failureReason

setFailureReason

public void setFailureReason(TransferFailure failureReason)

sweepId

public TransferEvent sweepId(String sweepId)

getSweepId

@Nullable
public String getSweepId()

Plaid’s unique identifier for a sweep.

Returns:

sweepId

setSweepId

public void setSweepId(String sweepId)

sweepAmount

public TransferEvent sweepAmount(String sweepAmount)

getSweepAmount

@Nullable
public String getSweepAmount()

A signed amount of how much was `swept` or `return_swept` for this transfer (decimal string with two digits of precision e.g. \"-5.50\").

Returns:

sweepAmount

setSweepAmount

public void setSweepAmount(String sweepAmount)

refundId

public TransferEvent refundId(String refundId)

getRefundId

@Nullable
public String getRefundId()

Plaid’s unique identifier for a refund. A non-null value indicates the event is for the associated refund of the transfer.

Returns:

refundId

setRefundId

public void setRefundId(String refundId)

originatorClientId

public TransferEvent originatorClientId(String originatorClientId)

getOriginatorClientId

@Nullable
public String getOriginatorClientId()

The Plaid client ID that is the originator of the transfer that this event applies to. Only present if the transfer was created on behalf of another client as a third-party sender (TPS).

Returns:

originatorClientId

setOriginatorClientId

public void setOriginatorClientId(String originatorClientId)

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