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

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class TransferIntentGet
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_AUTHORIZATION_DECISION`
`static String`	`SERIALIZED_NAME_AUTHORIZATION_DECISION_RATIONALE`
`static String`	`SERIALIZED_NAME_CREATED`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_FAILURE_REASON`
`static String`	`SERIALIZED_NAME_FUNDING_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_GUARANTEE_DECISION`
`static String`	`SERIALIZED_NAME_GUARANTEE_DECISION_RATIONALE`
`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_TRANSFER_ID`
`static String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors
Constructor and Description

TransferIntentGet()

Constructors
Constructor and Description
`TransferIntentGet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferIntentGet`	`accountId(String accountId)`
`TransferIntentGet`	`achClass(ACHClass achClass)`
`TransferIntentGet`	`amount(String amount)`
`TransferIntentGet`	`authorizationDecision(TransferIntentAuthorizationDecision authorizationDecision)`
`TransferIntentGet`	`authorizationDecisionRationale(TransferAuthorizationDecisionRationale authorizationDecisionRationale)`
`TransferIntentGet`	`created(OffsetDateTime created)`
`TransferIntentGet`	`description(String description)`
`boolean`	`equals(Object o)`
`TransferIntentGet`	`failureReason(TransferIntentGetFailureReason failureReason)`
`TransferIntentGet`	`fundingAccountId(String fundingAccountId)`
`String`	`getAccountId()` The Plaid `account_id` for the 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.
`TransferIntentAuthorizationDecision`	`getAuthorizationDecision()` Get authorizationDecision
`TransferAuthorizationDecisionRationale`	`getAuthorizationDecisionRationale()` Get authorizationDecisionRationale
`OffsetDateTime`	`getCreated()` The datetime the transfer was created.
`String`	`getDescription()` A description for the underlying transfer.
`TransferIntentGetFailureReason`	`getFailureReason()` Get failureReason
`String`	`getFundingAccountId()` The id of the funding account to use, available in the Plaid Dashboard.
`TransferAuthorizationGuaranteeDecision`	`getGuaranteeDecision()` Get guaranteeDecision
`TransferAuthorizationGuaranteeDecisionRationale`	`getGuaranteeDecisionRationale()` Get guaranteeDecisionRationale
`String`	`getId()` Plaid's unique identifier for a 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 used for the transfer.
`Boolean`	`getRequireGuarantee()` When `true`, the transfer requires a `GUARANTEED` decision by Plaid to proceed (Guarantee customers only).
`TransferIntentStatus`	`getStatus()` Get status
`String`	`getTransferId()` Plaid's unique identifier for the transfer created through the UI.
`TransferUserInResponse`	`getUser()` Get user
`TransferIntentGet`	`guaranteeDecision(TransferAuthorizationGuaranteeDecision guaranteeDecision)`
`TransferIntentGet`	`guaranteeDecisionRationale(TransferAuthorizationGuaranteeDecisionRationale guaranteeDecisionRationale)`
`int`	`hashCode()`
`TransferIntentGet`	`id(String id)`
`TransferIntentGet`	`isoCurrencyCode(String isoCurrencyCode)`
`TransferIntentGet`	`metadata(Map<String,String> metadata)`
`TransferIntentGet`	`mode(TransferIntentCreateMode mode)`
`TransferIntentGet`	`network(TransferIntentCreateNetwork network)`
`TransferIntentGet`	`originationAccountId(String originationAccountId)`
`TransferIntentGet`	`putMetadataItem(String key, String metadataItem)`
`TransferIntentGet`	`requireGuarantee(Boolean requireGuarantee)`
`void`	`setAccountId(String accountId)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(String amount)`
`void`	`setAuthorizationDecision(TransferIntentAuthorizationDecision authorizationDecision)`
`void`	`setAuthorizationDecisionRationale(TransferAuthorizationDecisionRationale authorizationDecisionRationale)`
`void`	`setCreated(OffsetDateTime created)`
`void`	`setDescription(String description)`
`void`	`setFailureReason(TransferIntentGetFailureReason failureReason)`
`void`	`setFundingAccountId(String fundingAccountId)`
`void`	`setGuaranteeDecision(TransferAuthorizationGuaranteeDecision guaranteeDecision)`
`void`	`setGuaranteeDecisionRationale(TransferAuthorizationGuaranteeDecisionRationale guaranteeDecisionRationale)`
`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`	`setTransferId(String transferId)`
`void`	`setUser(TransferUserInResponse user)`
`TransferIntentGet`	`status(TransferIntentStatus status)`
`String`	`toString()`
`TransferIntentGet`	`transferId(String transferId)`
`TransferIntentGet`	`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_TRANSFER_ID

public static final String SERIALIZED_NAME_TRANSFER_ID

See Also:: Constant Field Values

SERIALIZED_NAME_FAILURE_REASON

public static final String SERIALIZED_NAME_FAILURE_REASON

See Also:: Constant Field Values

SERIALIZED_NAME_AUTHORIZATION_DECISION

public static final String SERIALIZED_NAME_AUTHORIZATION_DECISION

See Also:: Constant Field Values

SERIALIZED_NAME_AUTHORIZATION_DECISION_RATIONALE

public static final String SERIALIZED_NAME_AUTHORIZATION_DECISION_RATIONALE

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

SERIALIZED_NAME_GUARANTEE_DECISION

public static final String SERIALIZED_NAME_GUARANTEE_DECISION

See Also:: Constant Field Values

SERIALIZED_NAME_GUARANTEE_DECISION_RATIONALE

public static final String SERIALIZED_NAME_GUARANTEE_DECISION_RATIONALE

See Also:: Constant Field Values

Constructor Detail
- TransferIntentGet
```
public TransferIntentGet()
```

Method Detail

id

public TransferIntentGet id(String id)

getId
```
public String getId()
```
Plaid's unique identifier for a transfer intent object.

Returns:

id

setId
```
public void setId(String id)
```

created

public TransferIntentGet 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 TransferIntentGet status(TransferIntentStatus status)

getStatus

public TransferIntentStatus getStatus()

Get status

Returns:: status

setStatus

public void setStatus(TransferIntentStatus status)

transferId

public TransferIntentGet transferId(String transferId)

getTransferId
```
@Nullable
public String getTransferId()
```
Plaid's unique identifier for the transfer created through the UI. Returned only if the transfer was successfully created. Null value otherwise.

Returns:

transferId

setTransferId

public void setTransferId(String transferId)

failureReason

public TransferIntentGet failureReason(TransferIntentGetFailureReason failureReason)

getFailureReason

@Nullable
public TransferIntentGetFailureReason getFailureReason()

Get failureReason

Returns:: failureReason

setFailureReason

public void setFailureReason(TransferIntentGetFailureReason failureReason)

authorizationDecision

public TransferIntentGet authorizationDecision(TransferIntentAuthorizationDecision authorizationDecision)

getAuthorizationDecision

@Nullable
public TransferIntentAuthorizationDecision getAuthorizationDecision()

Get authorizationDecision

Returns:: authorizationDecision

setAuthorizationDecision

public void setAuthorizationDecision(TransferIntentAuthorizationDecision authorizationDecision)

authorizationDecisionRationale

public TransferIntentGet authorizationDecisionRationale(TransferAuthorizationDecisionRationale authorizationDecisionRationale)

getAuthorizationDecisionRationale
```
@Nullable
public TransferAuthorizationDecisionRationale getAuthorizationDecisionRationale()
```
Get authorizationDecisionRationale

Returns:

authorizationDecisionRationale

setAuthorizationDecisionRationale

public void setAuthorizationDecisionRationale(TransferAuthorizationDecisionRationale authorizationDecisionRationale)

accountId

public TransferIntentGet accountId(String accountId)

getAccountId
```
@Nullable
public String getAccountId()
```
The Plaid `account_id` for the 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 TransferIntentGet originationAccountId(String originationAccountId)

getOriginationAccountId
```
public String getOriginationAccountId()
```
Plaid’s unique identifier for the origination account used for the transfer.

Returns:

originationAccountId

setOriginationAccountId

public void setOriginationAccountId(String originationAccountId)

fundingAccountId

public TransferIntentGet 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 TransferIntentGet 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 TransferIntentGet mode(TransferIntentCreateMode mode)

getMode

public TransferIntentCreateMode getMode()

Get mode

Returns:: mode

setMode

public void setMode(TransferIntentCreateMode mode)

network

public TransferIntentGet network(TransferIntentCreateNetwork network)

getNetwork

@Nullable
public TransferIntentCreateNetwork getNetwork()

Get network

Returns:: network

setNetwork

public void setNetwork(TransferIntentCreateNetwork network)

achClass

public TransferIntentGet achClass(ACHClass achClass)

getAchClass

@Nullable
public ACHClass getAchClass()

Get achClass

Returns:: achClass

setAchClass

public void setAchClass(ACHClass achClass)

user

public TransferIntentGet user(TransferUserInResponse user)

getUser

public TransferUserInResponse getUser()

Get user

Returns:: user

setUser

public void setUser(TransferUserInResponse user)

description

public TransferIntentGet 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 TransferIntentGet metadata(Map<String,String> metadata)

putMetadataItem

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

guaranteeDecision

public TransferIntentGet guaranteeDecision(TransferAuthorizationGuaranteeDecision guaranteeDecision)

getGuaranteeDecision

@Nullable
public TransferAuthorizationGuaranteeDecision getGuaranteeDecision()

Get guaranteeDecision

Returns:: guaranteeDecision

setGuaranteeDecision

public void setGuaranteeDecision(TransferAuthorizationGuaranteeDecision guaranteeDecision)

guaranteeDecisionRationale

public TransferIntentGet guaranteeDecisionRationale(TransferAuthorizationGuaranteeDecisionRationale guaranteeDecisionRationale)

getGuaranteeDecisionRationale

@Nullable
public TransferAuthorizationGuaranteeDecisionRationale getGuaranteeDecisionRationale()

Get guaranteeDecisionRationale

Returns:: guaranteeDecisionRationale

setGuaranteeDecisionRationale

public void setGuaranteeDecisionRationale(TransferAuthorizationGuaranteeDecisionRationale guaranteeDecisionRationale)

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 TransferIntentGet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_CREATED

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_TRANSFER_ID

SERIALIZED_NAME_FAILURE_REASON

SERIALIZED_NAME_AUTHORIZATION_DECISION

SERIALIZED_NAME_AUTHORIZATION_DECISION_RATIONALE

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

SERIALIZED_NAME_FUNDING_ACCOUNT_ID

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_MODE

SERIALIZED_NAME_NETWORK

SERIALIZED_NAME_ACH_CLASS

SERIALIZED_NAME_USER

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_REQUIRE_GUARANTEE

SERIALIZED_NAME_GUARANTEE_DECISION

SERIALIZED_NAME_GUARANTEE_DECISION_RATIONALE

Constructor Detail

TransferIntentGet

Method Detail

id

getId

setId

created

getCreated

setCreated

status

getStatus

setStatus

transferId

getTransferId

setTransferId

failureReason

getFailureReason

setFailureReason

authorizationDecision

getAuthorizationDecision

setAuthorizationDecision

authorizationDecisionRationale

getAuthorizationDecisionRationale

setAuthorizationDecisionRationale

accountId

getAccountId

setAccountId

originationAccountId

getOriginationAccountId

setOriginationAccountId

fundingAccountId

getFundingAccountId

setFundingAccountId

amount

getAmount

setAmount

mode

getMode

setMode

network

getNetwork

setNetwork

achClass

getAchClass

setAchClass

user

getUser

setUser

description

getDescription

setDescription

metadata

putMetadataItem