com.plaid.client.model

Class SimulatedTransferSweep

java.lang.Object

com.plaid.client.model.SimulatedTransferSweep

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

A sweep returned from the `/sandbox/transfer/sweep/simulate` endpoint. Can be null if there are no transfers to include in a sweep.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_AMOUNT
static String	SERIALIZED_NAME_CREATED
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_FUNDING_ACCOUNT_ID
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_ISO_CURRENCY_CODE
static String	SERIALIZED_NAME_SETTLED
static String	SERIALIZED_NAME_STATUS
static String	SERIALIZED_NAME_TRIGGER

Constructor Summary

Constructors

Constructor and Description
SimulatedTransferSweep()

Method Summary

Modifier and Type	Method and Description
SimulatedTransferSweep	amount(String amount)
SimulatedTransferSweep	created(OffsetDateTime created)
SimulatedTransferSweep	description(String description)
boolean	equals(Object o)
SimulatedTransferSweep	fundingAccountId(String fundingAccountId)
String	getAmount() Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g.
OffsetDateTime	getCreated() The datetime when the sweep occurred, in RFC 3339 format.
String	getDescription() The description of the deposit that will be passed to the receiving bank (up to 10 characters).
String	getFundingAccountId() The id of the funding account to use, available in the Plaid Dashboard.
String	getId() Identifier of the sweep.
String	getIsoCurrencyCode() The currency of the sweep, e.g.
LocalDate	getSettled() The date when the sweep settled, in the YYYY-MM-DD format.
SweepStatus	getStatus() Get status
SweepTrigger	getTrigger() Get trigger
int	hashCode()
SimulatedTransferSweep	id(String id)
SimulatedTransferSweep	isoCurrencyCode(String isoCurrencyCode)
void	setAmount(String amount)
void	setCreated(OffsetDateTime created)
void	setDescription(String description)
void	setFundingAccountId(String fundingAccountId)
void	setId(String id)
void	setIsoCurrencyCode(String isoCurrencyCode)
void	setSettled(LocalDate settled)
void	setStatus(SweepStatus status)
SimulatedTransferSweep	settled(LocalDate settled)
void	setTrigger(SweepTrigger trigger)
SimulatedTransferSweep	status(SweepStatus status)
String	toString()
SimulatedTransferSweep	trigger(SweepTrigger trigger)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID

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

public static final String SERIALIZED_NAME_CREATED

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_SETTLED

public static final String SERIALIZED_NAME_SETTLED

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_TRIGGER

public static final String SERIALIZED_NAME_TRIGGER

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

SimulatedTransferSweep

public SimulatedTransferSweep()

Method Detail

id

public SimulatedTransferSweep id(String id)

getId

public String getId()

Identifier of the sweep.

Returns:

id

setId

public void setId(String id)

fundingAccountId

public SimulatedTransferSweep fundingAccountId(String fundingAccountId)

getFundingAccountId

public String getFundingAccountId()

The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.

Returns:

fundingAccountId

setFundingAccountId

public void setFundingAccountId(String fundingAccountId)

created

public SimulatedTransferSweep created(OffsetDateTime created)

getCreated

public OffsetDateTime getCreated()

The datetime when the sweep occurred, in RFC 3339 format.

Returns:

created

setCreated

public void setCreated(OffsetDateTime created)

amount

public SimulatedTransferSweep amount(String amount)

getAmount

public String getAmount()

Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. \"-10.00\") If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.

Returns:

amount

setAmount

public void setAmount(String amount)

isoCurrencyCode

public SimulatedTransferSweep isoCurrencyCode(String isoCurrencyCode)

getIsoCurrencyCode

public String getIsoCurrencyCode()

The currency of the sweep, e.g. \"USD\".

Returns:

isoCurrencyCode

setIsoCurrencyCode

public void setIsoCurrencyCode(String isoCurrencyCode)

settled

public SimulatedTransferSweep settled(LocalDate settled)

getSettled

@Nullable
public LocalDate getSettled()

The date when the sweep settled, in the YYYY-MM-DD format.

Returns:

settled

setSettled

public void setSettled(LocalDate settled)

status

public SimulatedTransferSweep status(SweepStatus status)

getStatus

@Nullable
public SweepStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(SweepStatus status)

trigger

public SimulatedTransferSweep trigger(SweepTrigger trigger)

getTrigger

@Nullable
public SweepTrigger getTrigger()

Get trigger

Returns:

trigger

setTrigger

public void setTrigger(SweepTrigger trigger)

description

public SimulatedTransferSweep description(String description)

getDescription

@Nullable
public String getDescription()

The description of the deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.

Returns:

description

setDescription

public void setDescription(String description)

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