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

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

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

Defines the request schema for `/transfer/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_AUTHORIZATION_ID`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_FACILITATOR_FEE`
`static String`	`SERIALIZED_NAME_IDEMPOTENCY_KEY`
`static String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`static String`	`SERIALIZED_NAME_METADATA`
`static String`	`SERIALIZED_NAME_NETWORK`
`static String`	`SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_TEST_CLOCK_ID`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors
Constructor and Description

TransferCreateRequest()

Constructors
Constructor and Description
`TransferCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferCreateRequest`	`accessToken(String accessToken)`
`TransferCreateRequest`	`accountId(String accountId)`
`TransferCreateRequest`	`achClass(ACHClass achClass)`
`TransferCreateRequest`	`amount(String amount)`
`TransferCreateRequest`	`authorizationId(String authorizationId)`
`TransferCreateRequest`	`clientId(String clientId)`
`TransferCreateRequest`	`description(String description)`
`boolean`	`equals(Object o)`
`TransferCreateRequest`	`facilitatorFee(String facilitatorFee)`
`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`	`getAuthorizationId()` Plaid’s unique identifier for a transfer authorization.
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getDescription()` The transfer description.
`String`	`getFacilitatorFee()` The amount to deduct from `transfer.amount` and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g.
`String`	`getIdempotencyKey()` Deprecated.
`String`	`getIsoCurrencyCode()` The currency of the transfer amount.
`Map<String,String>`	`getMetadata()` The Metadata object is a mapping of client-provided string fields to any string value.
`TransferNetwork`	`getNetwork()` Get network
`String`	`getOriginationAccountId()` Plaid’s unique identifier for the origination account for this transfer.
`String`	`getSecret()` Your Plaid API `secret`.
`String`	`getTestClockId()` Plaid’s unique identifier for a test clock.
`TransferType`	`getType()` Get type
`TransferUserInRequestDeprecated`	`getUser()` Get user
`int`	`hashCode()`
`TransferCreateRequest`	`idempotencyKey(String idempotencyKey)`
`TransferCreateRequest`	`isoCurrencyCode(String isoCurrencyCode)`
`TransferCreateRequest`	`metadata(Map<String,String> metadata)`
`TransferCreateRequest`	`network(TransferNetwork network)`
`TransferCreateRequest`	`originationAccountId(String originationAccountId)`
`TransferCreateRequest`	`putMetadataItem(String key, String metadataItem)`
`TransferCreateRequest`	`secret(String secret)`
`void`	`setAccessToken(String accessToken)`
`void`	`setAccountId(String accountId)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(String amount)`
`void`	`setAuthorizationId(String authorizationId)`
`void`	`setClientId(String clientId)`
`void`	`setDescription(String description)`
`void`	`setFacilitatorFee(String facilitatorFee)`
`void`	`setIdempotencyKey(String idempotencyKey)`
`void`	`setIsoCurrencyCode(String isoCurrencyCode)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setNetwork(TransferNetwork network)`
`void`	`setOriginationAccountId(String originationAccountId)`
`void`	`setSecret(String secret)`
`void`	`setTestClockId(String testClockId)`
`void`	`setType(TransferType type)`
`void`	`setUser(TransferUserInRequestDeprecated user)`
`TransferCreateRequest`	`testClockId(String testClockId)`
`String`	`toString()`
`TransferCreateRequest`	`type(TransferType type)`
`TransferCreateRequest`	`user(TransferUserInRequestDeprecated 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_IDEMPOTENCY_KEY
```
public static final String SERIALIZED_NAME_IDEMPOTENCY_KEY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCESS_TOKEN
```
public static final String SERIALIZED_NAME_ACCESS_TOKEN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AUTHORIZATION_ID
```
public static final String SERIALIZED_NAME_AUTHORIZATION_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_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_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_ORIGINATION_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ORIGINATION_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_TEST_CLOCK_ID
```
public static final String SERIALIZED_NAME_TEST_CLOCK_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FACILITATOR_FEE
```
public static final String SERIALIZED_NAME_FACILITATOR_FEE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransferCreateRequest
```
public TransferCreateRequest()
```
- Method Detail
  - clientId
```
public TransferCreateRequest 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 TransferCreateRequest 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)
```
  - idempotencyKey
```
public TransferCreateRequest idempotencyKey(String idempotencyKey)
```
  - getIdempotencyKey
```
@Nullable
public String getIdempotencyKey()
```
    Deprecated. `authorization_id` is now used as idempotency instead. A random key provided by the client, per unique 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 transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.
    
    Returns:
    
    idempotencyKey
  - setIdempotencyKey
```
public void setIdempotencyKey(String idempotencyKey)
```
  - accessToken
```
public TransferCreateRequest accessToken(String accessToken)
```
  - getAccessToken
```
@Nullable
public String getAccessToken()
```
    The Plaid `access_token` for the account that will be debited or credited.
    
    Returns:
    
    accessToken
  - setAccessToken
```
public void setAccessToken(String accessToken)
```
  - accountId
```
public TransferCreateRequest 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)
```
  - authorizationId
```
public TransferCreateRequest authorizationId(String authorizationId)
```
  - getAuthorizationId
```
public String getAuthorizationId()
```
    Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.
    
    Returns:
    
    authorizationId
  - setAuthorizationId
```
public void setAuthorizationId(String authorizationId)
```
  - type
```
public TransferCreateRequest type(TransferType type)
```
  - getType
```
@Nullable
public TransferType getType()
```
    Get type
    
    Returns:
    
    type
  - setType
```
public void setType(TransferType type)
```
  - network
```
public TransferCreateRequest network(TransferNetwork network)
```
  - getNetwork
```
@Nullable
public TransferNetwork getNetwork()
```
    Get network
    
    Returns:
    
    network
  - setNetwork
```
public void setNetwork(TransferNetwork network)
```
  - amount
```
public TransferCreateRequest amount(String amount)
```
  - getAmount
```
@Nullable
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 TransferCreateRequest description(String description)
```
  - getDescription
```
public String getDescription()
```
    The transfer description. Maximum of 15 characters. If reprocessing a returned transfer, please note that the `description` field must be `\"Retry\"` to indicate that it's a retry of a previously returned transfer. You may retry a transfer up to 2 times, within 180 days of creating the original transfer. Only transfers that were returned with code `R01` or `R09` may be retried. For a full listing of ACH return codes, see [Transfer errors](https://plaid.com/docs/errors/transfer/#ach-return-codes).
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - achClass
```
public TransferCreateRequest achClass(ACHClass achClass)
```
  - getAchClass
```
@Nullable
public ACHClass getAchClass()
```
    Get achClass
    
    Returns:
    
    achClass
  - setAchClass
```
public void setAchClass(ACHClass achClass)
```
  - user
```
public TransferCreateRequest user(TransferUserInRequestDeprecated user)
```
  - getUser
```
@Nullable
public TransferUserInRequestDeprecated getUser()
```
    Get user
    
    Returns:
    
    user
  - setUser
```
public void setUser(TransferUserInRequestDeprecated user)
```
  - metadata
```
public TransferCreateRequest metadata(Map<String,String> metadata)
```
  - putMetadataItem
```
public TransferCreateRequest 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)
```
  - originationAccountId
```
public TransferCreateRequest originationAccountId(String originationAccountId)
```
  - getOriginationAccountId
```
@Nullable
public String getOriginationAccountId()
```
    Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.
    
    Returns:
    
    originationAccountId
  - setOriginationAccountId
```
public void setOriginationAccountId(String originationAccountId)
```
  - isoCurrencyCode
```
public TransferCreateRequest 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)
```
  - testClockId
```
public TransferCreateRequest 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 `transfer` is created at the `virtual_time` on the provided `test_clock`.
    
    Returns:
    
    testClockId
  - setTestClockId
```
public void setTestClockId(String testClockId)
```
  - facilitatorFee
```
public TransferCreateRequest facilitatorFee(String facilitatorFee)
```
  - getFacilitatorFee
```
@Nullable
public String getFacilitatorFee()
```
    The amount to deduct from `transfer.amount` and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. \"10.00\"). The remainder will go to the end-customer’s Ledger balance. This must be less than or equal to the `transfer.amount`.
    
    Returns:
    
    facilitatorFee
  - setFacilitatorFee
```
public void setFacilitatorFee(String facilitatorFee)
```
  - 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 TransferCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_IDEMPOTENCY_KEY

SERIALIZED_NAME_ACCESS_TOKEN

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_AUTHORIZATION_ID

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_NETWORK

SERIALIZED_NAME_AMOUNT

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_ACH_CLASS

SERIALIZED_NAME_USER

SERIALIZED_NAME_METADATA

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

SERIALIZED_NAME_ISO_CURRENCY_CODE

SERIALIZED_NAME_TEST_CLOCK_ID

SERIALIZED_NAME_FACILITATOR_FEE

Constructor Detail

TransferCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

idempotencyKey

getIdempotencyKey

setIdempotencyKey

accessToken

getAccessToken

setAccessToken

accountId

getAccountId

setAccountId

authorizationId

getAuthorizationId

setAuthorizationId

type

getType

setType

network

getNetwork

setNetwork

amount

getAmount

setAmount

description

getDescription

setDescription

achClass

getAchClass

setAchClass

user

getUser

setUser

metadata

putMetadataItem

getMetadata

setMetadata

originationAccountId

getOriginationAccountId

setOriginationAccountId

isoCurrencyCode

getIsoCurrencyCode

setIsoCurrencyCode

testClockId

getTestClockId

setTestClockId

facilitatorFee

getFacilitatorFee

setFacilitatorFee

equals

hashCode