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

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

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

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

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_CLIENT_ID`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_FUNDING_ACCOUNT_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_SECRET`
`static String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors
Constructor and Description

TransferIntentCreateRequest()

Constructors
Constructor and Description
`TransferIntentCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferIntentCreateRequest`	`accountId(String accountId)`
`TransferIntentCreateRequest`	`achClass(ACHClass achClass)`
`TransferIntentCreateRequest`	`amount(String amount)`
`TransferIntentCreateRequest`	`clientId(String clientId)`
`TransferIntentCreateRequest`	`description(String description)`
`boolean`	`equals(Object o)`
`TransferIntentCreateRequest`	`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.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getDescription()` A description for the underlying transfer.
`String`	`getFundingAccountId()` Specify the account used to fund the transfer.
`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).
`String`	`getSecret()` Your Plaid API `secret`.
`TransferUserInRequest`	`getUser()` Get user
`int`	`hashCode()`
`TransferIntentCreateRequest`	`isoCurrencyCode(String isoCurrencyCode)`
`TransferIntentCreateRequest`	`metadata(Map<String,String> metadata)`
`TransferIntentCreateRequest`	`mode(TransferIntentCreateMode mode)`
`TransferIntentCreateRequest`	`network(TransferIntentCreateNetwork network)`
`TransferIntentCreateRequest`	`originationAccountId(String originationAccountId)`
`TransferIntentCreateRequest`	`putMetadataItem(String key, String metadataItem)`
`TransferIntentCreateRequest`	`requireGuarantee(Boolean requireGuarantee)`
`TransferIntentCreateRequest`	`secret(String secret)`
`void`	`setAccountId(String accountId)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(String amount)`
`void`	`setClientId(String clientId)`
`void`	`setDescription(String description)`
`void`	`setFundingAccountId(String fundingAccountId)`
`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`	`setSecret(String secret)`
`void`	`setUser(TransferUserInRequest user)`
`String`	`toString()`
`TransferIntentCreateRequest`	`user(TransferUserInRequest user)`

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

public static final String SERIALIZED_NAME_AMOUNT

See Also:: Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:: Constant Field Values

SERIALIZED_NAME_ACH_CLASS

public static final String SERIALIZED_NAME_ACH_CLASS

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_USER

public static final String SERIALIZED_NAME_USER

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
- TransferIntentCreateRequest
```
public TransferIntentCreateRequest()
```

Method Detail

clientId

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

accountId

public TransferIntentCreateRequest accountId(String accountId)

getAccountId
```
@Nullable
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 TransferIntentCreateRequest 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)

mode

public TransferIntentCreateRequest mode(TransferIntentCreateMode mode)

getMode

public TransferIntentCreateMode getMode()

Get mode

Returns:: mode

setMode

public void setMode(TransferIntentCreateMode mode)

network

public TransferIntentCreateRequest network(TransferIntentCreateNetwork network)

getNetwork

@Nullable
public TransferIntentCreateNetwork getNetwork()

Get network

Returns:: network

setNetwork

public void setNetwork(TransferIntentCreateNetwork network)

amount

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

description

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

achClass

public TransferIntentCreateRequest achClass(ACHClass achClass)

getAchClass

@Nullable
public ACHClass getAchClass()

Get achClass

Returns:: achClass

setAchClass

public void setAchClass(ACHClass achClass)

originationAccountId

public TransferIntentCreateRequest originationAccountId(String originationAccountId)

getOriginationAccountId
```
@Nullable
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)

user

public TransferIntentCreateRequest user(TransferUserInRequest user)

getUser

public TransferUserInRequest getUser()

Get user

Returns:: user

setUser

public void setUser(TransferUserInRequest user)

metadata

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

putMetadataItem

public TransferIntentCreateRequest 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 TransferIntentCreateRequest isoCurrencyCode(String isoCurrencyCode)

getIsoCurrencyCode
```
@Nullable
public String getIsoCurrencyCode()
```
The currency of the transfer amount, e.g. \"USD\"

Returns:

isoCurrencyCode

setIsoCurrencyCode

public void setIsoCurrencyCode(String isoCurrencyCode)

requireGuarantee

public TransferIntentCreateRequest 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

Class TransferIntentCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_FUNDING_ACCOUNT_ID

SERIALIZED_NAME_MODE

SERIALIZED_NAME_NETWORK

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_ACH_CLASS

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

SERIALIZED_NAME_USER

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_REQUIRE_GUARANTEE

Constructor Detail

TransferIntentCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

accountId

getAccountId

setAccountId

fundingAccountId

getFundingAccountId

setFundingAccountId

mode

getMode

setMode

network

getNetwork

setNetwork

amount

getAmount

setAmount

description

getDescription

setDescription

achClass

getAchClass

setAchClass

originationAccountId

getOriginationAccountId

setOriginationAccountId

user

getUser

setUser

metadata

putMetadataItem

getMetadata

setMetadata

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

requireGuarantee

getRequireGuarantee

setRequireGuarantee

equals

hashCode

toString