com.plaid.client.model

Class RecurringTransfer

java.lang.Object

com.plaid.client.model.RecurringTransfer

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

Represents a recurring transfer within the Transfers API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_ID
static String	SERIALIZED_NAME_ACH_CLASS
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_ISO_CURRENCY_CODE
static String	SERIALIZED_NAME_NETWORK
static String	SERIALIZED_NAME_NEXT_ORIGINATION_DATE
static String	SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
static String	SERIALIZED_NAME_RECURRING_TRANSFER_ID
static String	SERIALIZED_NAME_SCHEDULE
static String	SERIALIZED_NAME_STATUS
static String	SERIALIZED_NAME_TEST_CLOCK_ID
static String	SERIALIZED_NAME_TRANSFER_IDS
static String	SERIALIZED_NAME_TYPE
static String	SERIALIZED_NAME_USER

Constructor Summary

Constructors

Constructor and Description
RecurringTransfer()

Method Summary

Modifier and Type	Method and Description
RecurringTransfer	accountId(String accountId)
RecurringTransfer	achClass(ACHClass achClass)
RecurringTransfer	addTransferIdsItem(String transferIdsItem)
RecurringTransfer	amount(String amount)
RecurringTransfer	created(OffsetDateTime created)
RecurringTransfer	description(String description)
boolean	equals(Object o)
RecurringTransfer	fundingAccountId(String fundingAccountId)
String	getAccountId() The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
ACHClass	getAchClass() Get achClass
String	getAmount() The amount of the transfer (decimal string with two digits of precision e.g.
OffsetDateTime	getCreated() The datetime when this transfer was created.
String	getDescription() The description of the recurring transfer.
String	getFundingAccountId() The id of the funding account to use, available in the Plaid Dashboard.
String	getIsoCurrencyCode() The currency of the transfer amount, e.g.
TransferNetwork	getNetwork() Get network
LocalDate	getNextOriginationDate() A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
String	getOriginationAccountId() Plaid’s unique identifier for the origination account that was used for this transfer.
String	getRecurringTransferId() Plaid’s unique identifier for a recurring transfer.
TransferRecurringSchedule	getSchedule() Get schedule
TransferRecurringStatus	getStatus() Get status
String	getTestClockId() Plaid’s unique identifier for a test clock.
List<String>	getTransferIds() Get transferIds
TransferType	getType() Get type
TransferUserInResponse	getUser() Get user
int	hashCode()
RecurringTransfer	isoCurrencyCode(String isoCurrencyCode)
RecurringTransfer	network(TransferNetwork network)
RecurringTransfer	nextOriginationDate(LocalDate nextOriginationDate)
RecurringTransfer	originationAccountId(String originationAccountId)
RecurringTransfer	recurringTransferId(String recurringTransferId)
RecurringTransfer	schedule(TransferRecurringSchedule schedule)
void	setAccountId(String accountId)
void	setAchClass(ACHClass achClass)
void	setAmount(String amount)
void	setCreated(OffsetDateTime created)
void	setDescription(String description)
void	setFundingAccountId(String fundingAccountId)
void	setIsoCurrencyCode(String isoCurrencyCode)
void	setNetwork(TransferNetwork network)
void	setNextOriginationDate(LocalDate nextOriginationDate)
void	setOriginationAccountId(String originationAccountId)
void	setRecurringTransferId(String recurringTransferId)
void	setSchedule(TransferRecurringSchedule schedule)
void	setStatus(TransferRecurringStatus status)
void	setTestClockId(String testClockId)
void	setTransferIds(List<String> transferIds)
void	setType(TransferType type)
void	setUser(TransferUserInResponse user)
RecurringTransfer	status(TransferRecurringStatus status)
RecurringTransfer	testClockId(String testClockId)
String	toString()
RecurringTransfer	transferIds(List<String> transferIds)
RecurringTransfer	type(TransferType type)
RecurringTransfer	user(TransferUserInResponse user)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_RECURRING_TRANSFER_ID

public static final String SERIALIZED_NAME_RECURRING_TRANSFER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED

public static final String SERIALIZED_NAME_CREATED

See Also:

Constant Field Values

SERIALIZED_NAME_NEXT_ORIGINATION_DATE

public static final String SERIALIZED_NAME_NEXT_ORIGINATION_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_TEST_CLOCK_ID

public static final String SERIALIZED_NAME_TEST_CLOCK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_ACH_CLASS

public static final String SERIALIZED_NAME_ACH_CLASS

See Also:

Constant Field Values

SERIALIZED_NAME_NETWORK

public static final String SERIALIZED_NAME_NETWORK

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_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_ISO_CURRENCY_CODE

public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSFER_IDS

public static final String SERIALIZED_NAME_TRANSFER_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_USER

public static final String SERIALIZED_NAME_USER

See Also:

Constant Field Values

SERIALIZED_NAME_SCHEDULE

public static final String SERIALIZED_NAME_SCHEDULE

See Also:

Constant Field Values

Constructor Detail

RecurringTransfer

public RecurringTransfer()

Method Detail

recurringTransferId

public RecurringTransfer recurringTransferId(String recurringTransferId)

getRecurringTransferId

public String getRecurringTransferId()

Plaid’s unique identifier for a recurring transfer.

Returns:

recurringTransferId

setRecurringTransferId

public void setRecurringTransferId(String recurringTransferId)

created

public RecurringTransfer created(OffsetDateTime created)

getCreated

public OffsetDateTime getCreated()

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

Returns:

created

setCreated

public void setCreated(OffsetDateTime created)

nextOriginationDate

public RecurringTransfer nextOriginationDate(LocalDate nextOriginationDate)

getNextOriginationDate

@Nullable
public LocalDate getNextOriginationDate()

A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The next transfer origination date after bank holiday adjustment.

Returns:

nextOriginationDate

setNextOriginationDate

public void setNextOriginationDate(LocalDate nextOriginationDate)

testClockId

public RecurringTransfer testClockId(String testClockId)

getTestClockId

@Nullable
public String getTestClockId()

Plaid’s unique identifier for a test clock.

Returns:

testClockId

setTestClockId

public void setTestClockId(String testClockId)

type

public RecurringTransfer type(TransferType type)

getType

public TransferType getType()

Get type

Returns:

type

setType

public void setType(TransferType type)

amount

public RecurringTransfer amount(String amount)

getAmount

public String getAmount()

The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\").

Returns:

amount

setAmount

public void setAmount(String amount)

status

public RecurringTransfer status(TransferRecurringStatus status)

getStatus

public TransferRecurringStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(TransferRecurringStatus status)

achClass

public RecurringTransfer achClass(ACHClass achClass)

getAchClass

@Nullable
public ACHClass getAchClass()

Get achClass

Returns:

achClass

setAchClass

public void setAchClass(ACHClass achClass)

network

public RecurringTransfer network(TransferNetwork network)

getNetwork

public TransferNetwork getNetwork()

Get network

Returns:

network

setNetwork

public void setNetwork(TransferNetwork network)

originationAccountId

public RecurringTransfer originationAccountId(String originationAccountId)

getOriginationAccountId

public String getOriginationAccountId()

Plaid’s unique identifier for the origination account that was used for this transfer.

Returns:

originationAccountId

setOriginationAccountId

public void setOriginationAccountId(String originationAccountId)

accountId

public RecurringTransfer accountId(String accountId)

getAccountId

public String getAccountId()

The Plaid `account_id` corresponding to the end-user account that will be debited or credited.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

fundingAccountId

public RecurringTransfer 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)

isoCurrencyCode

public RecurringTransfer isoCurrencyCode(String isoCurrencyCode)

getIsoCurrencyCode

public String getIsoCurrencyCode()

The currency of the transfer amount, e.g. \"USD\"

Returns:

isoCurrencyCode

setIsoCurrencyCode

public void setIsoCurrencyCode(String isoCurrencyCode)

description

public RecurringTransfer description(String description)

getDescription

public String getDescription()

The description of the recurring transfer.

Returns:

description

setDescription

public void setDescription(String description)

transferIds

public RecurringTransfer transferIds(List<String> transferIds)

addTransferIdsItem

public RecurringTransfer addTransferIdsItem(String transferIdsItem)

getTransferIds

public List<String> getTransferIds()

Get transferIds

Returns:

transferIds

setTransferIds

public void setTransferIds(List<String> transferIds)

user

public RecurringTransfer user(TransferUserInResponse user)

getUser

public TransferUserInResponse getUser()

Get user

Returns:

user

setUser

public void setUser(TransferUserInResponse user)

schedule

public RecurringTransfer schedule(TransferRecurringSchedule schedule)

getSchedule

public TransferRecurringSchedule getSchedule()

Get schedule

Returns:

schedule

setSchedule

public void setSchedule(TransferRecurringSchedule schedule)

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