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

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

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

Defines the request schema for `/transfer/recurring/create`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCESS_TOKEN`
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_ACH_CLASS`
`static String`	`SERIALIZED_NAME_AMOUNT`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_DEVICE`
`static String`	`SERIALIZED_NAME_FUNDING_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_IDEMPOTENCY_KEY`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_NETWORK`
`static String`	`SERIALIZED_NAME_SCHEDULE`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_TEST_CLOCK_ID`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_USER`
`static String`	`SERIALIZED_NAME_USER_PRESENT`

Constructor Summary

Constructors
Constructor and Description

TransferRecurringCreateRequest()

Constructors
Constructor and Description
`TransferRecurringCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferRecurringCreateRequest`	`accessToken(String accessToken)`
`TransferRecurringCreateRequest`	`accountId(String accountId)`
`TransferRecurringCreateRequest`	`achClass(ACHClass achClass)`
`TransferRecurringCreateRequest`	`amount(String amount)`
`TransferRecurringCreateRequest`	`clientId(String clientId)`
`TransferRecurringCreateRequest`	`description(String description)`
`TransferRecurringCreateRequest`	`device(TransferDevice device)`
`boolean`	`equals(Object o)`
`TransferRecurringCreateRequest`	`fundingAccountId(String fundingAccountId)`
`String`	`getAccessToken()` The Plaid `access_token` for the account that will be debited or credited.
`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.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getDescription()` The description of the recurring transfer.
`TransferDevice`	`getDevice()` Get device
`String`	`getFundingAccountId()` Specify the account used to fund the transfer.
`String`	`getIdempotencyKey()` A random key provided by the client, per unique recurring transfer.
`String`	`getIsoCurrencyCode()` The currency of the transfer amount.
`TransferNetwork`	`getNetwork()` Get network
`TransferRecurringSchedule`	`getSchedule()` Get schedule
`String`	`getSecret()` Your Plaid API `secret`.
`String`	`getTestClockId()` Plaid’s unique identifier for a test clock.
`TransferType`	`getType()` Get type
`TransferUserInRequest`	`getUser()` Get user
`Boolean`	`getUserPresent()` If the end user is initiating the specific transfer themselves via an interactive UI, this should be `true`; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be `false`.
`int`	`hashCode()`
`TransferRecurringCreateRequest`	`idempotencyKey(String idempotencyKey)`
`TransferRecurringCreateRequest`	`isoCurrencyCode(String isoCurrencyCode)`
`TransferRecurringCreateRequest`	`network(TransferNetwork network)`
`TransferRecurringCreateRequest`	`schedule(TransferRecurringSchedule schedule)`
`TransferRecurringCreateRequest`	`secret(String secret)`
`void`	`setAccessToken(String accessToken)`
`void`	`setAccountId(String accountId)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(String amount)`
`void`	`setClientId(String clientId)`
`void`	`setDescription(String description)`
`void`	`setDevice(TransferDevice device)`
`void`	`setFundingAccountId(String fundingAccountId)`
`void`	`setIdempotencyKey(String idempotencyKey)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setNetwork(TransferNetwork network)`
`void`	`setSchedule(TransferRecurringSchedule schedule)`
`void`	`setSecret(String secret)`
`void`	`setTestClockId(String testClockId)`
`void`	`setType(TransferType type)`
`void`	`setUser(TransferUserInRequest user)`
`void`	`setUserPresent(Boolean userPresent)`
`TransferRecurringCreateRequest`	`testClockId(String testClockId)`
`String`	`toString()`
`TransferRecurringCreateRequest`	`type(TransferType type)`
`TransferRecurringCreateRequest`	`user(TransferUserInRequest user)`
`TransferRecurringCreateRequest`	`userPresent(Boolean userPresent)`

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_ACCESS_TOKEN

public static final String SERIALIZED_NAME_ACCESS_TOKEN

See Also:: Constant Field Values

SERIALIZED_NAME_IDEMPOTENCY_KEY

public static final String SERIALIZED_NAME_IDEMPOTENCY_KEY

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_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:: Constant Field Values

SERIALIZED_NAME_NETWORK

public static final String SERIALIZED_NAME_NETWORK

See Also:: Constant Field Values

SERIALIZED_NAME_ACH_CLASS

public static final String SERIALIZED_NAME_ACH_CLASS

See Also:: Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:: Constant Field Values

SERIALIZED_NAME_USER_PRESENT

public static final String SERIALIZED_NAME_USER_PRESENT

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_TEST_CLOCK_ID

public static final String SERIALIZED_NAME_TEST_CLOCK_ID

See Also:: Constant Field Values

SERIALIZED_NAME_SCHEDULE

public static final String SERIALIZED_NAME_SCHEDULE

See Also:: Constant Field Values

SERIALIZED_NAME_USER

public static final String SERIALIZED_NAME_USER

See Also:: Constant Field Values

SERIALIZED_NAME_DEVICE

public static final String SERIALIZED_NAME_DEVICE

See Also:: Constant Field Values

Constructor Detail
- TransferRecurringCreateRequest
```
public TransferRecurringCreateRequest()
```

Method Detail

clientId

public TransferRecurringCreateRequest 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 TransferRecurringCreateRequest 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)
```

accessToken

public TransferRecurringCreateRequest accessToken(String accessToken)

getAccessToken
```
public String getAccessToken()
```
The Plaid `access_token` for the account that will be debited or credited.

Returns:

accessToken

setAccessToken

public void setAccessToken(String accessToken)

idempotencyKey

public TransferRecurringCreateRequest idempotencyKey(String idempotencyKey)

getIdempotencyKey
```
public String getIdempotencyKey()
```
A random key provided by the client, per unique recurring transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a recurring fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single recurring transfer is created.

Returns:

idempotencyKey

setIdempotencyKey

public void setIdempotencyKey(String idempotencyKey)

accountId

public TransferRecurringCreateRequest 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 TransferRecurringCreateRequest fundingAccountId(String fundingAccountId)

getFundingAccountId
```
@Nullable
public String getFundingAccountId()
```
Specify the account used to fund the transfer. Customers can find a list of `funding_account_id`s in the Accounts page of your Plaid Dashboard, under the \"Account ID\" column. If this field is left blank, it will default to the default `funding_account_id` specified during onboarding.

Returns:

fundingAccountId

setFundingAccountId

public void setFundingAccountId(String fundingAccountId)

type

public TransferRecurringCreateRequest type(TransferType type)

getType
```
public TransferType getType()
```
Get type

Returns:

type

setType

public void setType(TransferType type)

network

public TransferRecurringCreateRequest network(TransferNetwork network)

getNetwork
```
public TransferNetwork getNetwork()
```
Get network

Returns:

network

setNetwork

public void setNetwork(TransferNetwork network)

achClass

public TransferRecurringCreateRequest achClass(ACHClass achClass)

getAchClass

@Nullable
public ACHClass getAchClass()

Get achClass

Returns:: achClass

setAchClass

public void setAchClass(ACHClass achClass)

amount

public TransferRecurringCreateRequest 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)
```

userPresent

public TransferRecurringCreateRequest userPresent(Boolean userPresent)

getUserPresent
```
@Nullable
public Boolean getUserPresent()
```
If the end user is initiating the specific transfer themselves via an interactive UI, this should be `true`; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be `false`.

Returns:

userPresent

setUserPresent

public void setUserPresent(Boolean userPresent)

isoCurrencyCode

public TransferRecurringCreateRequest isoCurrencyCode(String isoCurrencyCode)

getIsoCurrencyCode
```
@Nullable
public String getIsoCurrencyCode()
```
The currency of the transfer amount. The default value is \"USD\".

Returns:

isoCurrencyCode

setIsoCurrencyCode

public void setIsoCurrencyCode(String isoCurrencyCode)

description

public TransferRecurringCreateRequest description(String description)

getDescription
```
public String getDescription()
```
The description of the recurring transfer.

Returns:

description

setDescription

public void setDescription(String description)

testClockId

public TransferRecurringCreateRequest testClockId(String testClockId)

getTestClockId
```
@Nullable
public String getTestClockId()
```
Plaid’s unique identifier for a test clock. This field may only be used when using `sandbox` environment. If provided, the created `recurring_transfer` is associated with the `test_clock`. New originations are automatically generated when the associated `test_clock` advances.

Returns:

testClockId

setTestClockId

public void setTestClockId(String testClockId)

schedule

public TransferRecurringCreateRequest schedule(TransferRecurringSchedule schedule)

getSchedule

public TransferRecurringSchedule getSchedule()

Get schedule

Returns:: schedule

setSchedule

public void setSchedule(TransferRecurringSchedule schedule)

user

public TransferRecurringCreateRequest user(TransferUserInRequest user)

getUser

public TransferUserInRequest getUser()

Get user

Returns:: user

setUser

public void setUser(TransferUserInRequest user)

device

public TransferRecurringCreateRequest device(TransferDevice device)

getDevice

@Nullable
public TransferDevice getDevice()

Get device

Returns:: device

setDevice

public void setDevice(TransferDevice device)

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 TransferRecurringCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_ACCESS_TOKEN

SERIALIZED_NAME_IDEMPOTENCY_KEY

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_FUNDING_ACCOUNT_ID

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_NETWORK

SERIALIZED_NAME_ACH_CLASS

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_USER_PRESENT

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_TEST_CLOCK_ID

SERIALIZED_NAME_SCHEDULE

SERIALIZED_NAME_USER

SERIALIZED_NAME_DEVICE

Constructor Detail

TransferRecurringCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

accessToken

getAccessToken

setAccessToken

idempotencyKey

getIdempotencyKey

setIdempotencyKey

accountId

getAccountId

setAccountId

fundingAccountId

getFundingAccountId

setFundingAccountId

type

getType

setType

network

getNetwork

setNetwork

achClass

getAchClass

setAchClass

amount

getAmount

setAmount

userPresent

getUserPresent

setUserPresent

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

description

getDescription

setDescription

testClockId

getTestClockId

setTestClockId

schedule

getSchedule

setSchedule

user

getUser

setUser

device

getDevice

setDevice

equals

hashCode

toString