com.plaid.client.model

Class TransferIntentCreate

java.lang.Object

com.plaid.client.model.TransferIntentCreate

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

Represents a transfer intent within Transfer UI.

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_ID
static String	SERIALIZED_NAME_ISO_CURRENCY_CODE
static String	SERIALIZED_NAME_METADATA
static String	SERIALIZED_NAME_MODE
static String	SERIALIZED_NAME_NETWORK
static String	SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
static String	SERIALIZED_NAME_REQUIRE_GUARANTEE
static String	SERIALIZED_NAME_STATUS
static String	SERIALIZED_NAME_USER

Constructor Summary

Constructors

Constructor and Description
TransferIntentCreate()

Method Summary

Modifier and Type	Method and Description
TransferIntentCreate	accountId(String accountId)
TransferIntentCreate	achClass(ACHClass achClass)
TransferIntentCreate	amount(String amount)
TransferIntentCreate	created(OffsetDateTime created)
TransferIntentCreate	description(String description)
boolean	equals(Object o)
TransferIntentCreate	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 the transfer was created.
String	getDescription() A description for the underlying transfer.
String	getFundingAccountId() The id of the funding account to use, available in the Plaid Dashboard.
String	getId() Plaid's unique identifier for the transfer intent object.
String	getIsoCurrencyCode() The currency of the transfer amount, e.g.
Map<String,String>	getMetadata() The Metadata object is a mapping of client-provided string fields to any string value.
TransferIntentCreateMode	getMode() Get mode
TransferIntentCreateNetwork	getNetwork() Get network
String	getOriginationAccountId() Plaid’s unique identifier for the origination account for the intent.
Boolean	getRequireGuarantee() When `true`, the transfer requires a `GUARANTEED` decision by Plaid to proceed (Guarantee customers only).
TransferIntentStatus	getStatus() Get status
TransferUserInResponse	getUser() Get user
int	hashCode()
TransferIntentCreate	id(String id)
TransferIntentCreate	isoCurrencyCode(String isoCurrencyCode)
TransferIntentCreate	metadata(Map<String,String> metadata)
TransferIntentCreate	mode(TransferIntentCreateMode mode)
TransferIntentCreate	network(TransferIntentCreateNetwork network)
TransferIntentCreate	originationAccountId(String originationAccountId)
TransferIntentCreate	putMetadataItem(String key, String metadataItem)
TransferIntentCreate	requireGuarantee(Boolean requireGuarantee)
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	setId(String id)
void	setIsoCurrencyCode(String isoCurrencyCode)
void	setMetadata(Map<String,String> metadata)
void	setMode(TransferIntentCreateMode mode)
void	setNetwork(TransferIntentCreateNetwork network)
void	setOriginationAccountId(String originationAccountId)
void	setRequireGuarantee(Boolean requireGuarantee)
void	setStatus(TransferIntentStatus status)
void	setUser(TransferUserInResponse user)
TransferIntentCreate	status(TransferIntentStatus status)
String	toString()
TransferIntentCreate	user(TransferUserInResponse user)

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_CREATED

public static final String SERIALIZED_NAME_CREATED

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_ID

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

public static final String SERIALIZED_NAME_FUNDING_ACCOUNT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_MODE

public static final String SERIALIZED_NAME_MODE

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_USER

public static final String SERIALIZED_NAME_USER

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

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_REQUIRE_GUARANTEE

public static final String SERIALIZED_NAME_REQUIRE_GUARANTEE

See Also:

Constant Field Values

Constructor Detail

TransferIntentCreate

public TransferIntentCreate()

Method Detail

id

public TransferIntentCreate id(String id)

getId

public String getId()

Plaid's unique identifier for the transfer intent object.

Returns:

id

setId

public void setId(String id)

created

public TransferIntentCreate created(OffsetDateTime created)

getCreated

public OffsetDateTime getCreated()

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

Returns:

created

setCreated

public void setCreated(OffsetDateTime created)

status

public TransferIntentCreate status(TransferIntentStatus status)

getStatus

public TransferIntentStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(TransferIntentStatus status)

accountId

public TransferIntentCreate accountId(String accountId)

getAccountId

@Nullable
public String getAccountId()

The Plaid `account_id` corresponding to the end-user account that will be debited or credited. Returned only if `account_id` was set on intent creation.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

originationAccountId

public TransferIntentCreate originationAccountId(String originationAccountId)

getOriginationAccountId

public String getOriginationAccountId()

Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.

Returns:

originationAccountId

setOriginationAccountId

public void setOriginationAccountId(String originationAccountId)

fundingAccountId

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

amount

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

mode

public TransferIntentCreate mode(TransferIntentCreateMode mode)

getMode

public TransferIntentCreateMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(TransferIntentCreateMode mode)

network

public TransferIntentCreate network(TransferIntentCreateNetwork network)

getNetwork

@Nullable
public TransferIntentCreateNetwork getNetwork()

Get network

Returns:

network

setNetwork

public void setNetwork(TransferIntentCreateNetwork network)

achClass

public TransferIntentCreate achClass(ACHClass achClass)

getAchClass

@Nullable
public ACHClass getAchClass()

Get achClass

Returns:

achClass

setAchClass

public void setAchClass(ACHClass achClass)

user

public TransferIntentCreate user(TransferUserInResponse user)

getUser

public TransferUserInResponse getUser()

Get user

Returns:

user

setUser

public void setUser(TransferUserInResponse user)

description

public TransferIntentCreate description(String description)

getDescription

public String getDescription()

A description for the underlying transfer. Maximum of 8 characters.

Returns:

description

setDescription

public void setDescription(String description)

metadata

public TransferIntentCreate metadata(Map<String,String> metadata)

putMetadataItem

public TransferIntentCreate putMetadataItem(String key,
                                            String metadataItem)

getMetadata

@Nullable
public Map<String,String> getMetadata()

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: The JSON values must be Strings (no nested JSON objects allowed) Only ASCII characters may be used Maximum of 50 key/value pairs Maximum key length of 40 characters Maximum value length of 500 characters

Returns:

metadata

setMetadata

public void setMetadata(Map<String,String> metadata)

isoCurrencyCode

public TransferIntentCreate isoCurrencyCode(String isoCurrencyCode)

getIsoCurrencyCode

public String getIsoCurrencyCode()

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

Returns:

isoCurrencyCode

setIsoCurrencyCode

public void setIsoCurrencyCode(String isoCurrencyCode)

requireGuarantee

public TransferIntentCreate requireGuarantee(Boolean requireGuarantee)

getRequireGuarantee

@Nullable
public Boolean getRequireGuarantee()

When `true`, the transfer requires a `GUARANTEED` decision by Plaid to proceed (Guarantee customers only).

Returns:

requireGuarantee

setRequireGuarantee

public void setRequireGuarantee(Boolean requireGuarantee)

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