java.lang.Object

com.plaid.client.model.TransferCreateRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class TransferCreateRequest
extends java.lang.Object

Defines the request schema for `/transfer/create`

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`SERIALIZED_NAME_ACCESS_TOKEN`
`static java.lang.String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static java.lang.String`	`SERIALIZED_NAME_ACH_CLASS`
`static java.lang.String`	`SERIALIZED_NAME_AMOUNT`
`static java.lang.String`	`SERIALIZED_NAME_AUTHORIZATION_ID`
`static java.lang.String`	`SERIALIZED_NAME_CLIENT_ID`
`static java.lang.String`	`SERIALIZED_NAME_DESCRIPTION`
`static java.lang.String`	`SERIALIZED_NAME_IDEMPOTENCY_KEY`
`static java.lang.String`	`SERIALIZED_NAME_METADATA`
`static java.lang.String`	`SERIALIZED_NAME_NETWORK`
`static java.lang.String`	`SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID`
`static java.lang.String`	`SERIALIZED_NAME_SECRET`
`static java.lang.String`	`SERIALIZED_NAME_TYPE`
`static java.lang.String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors

Constructor Description

TransferCreateRequest()

Method Summary

Modifier and Type	Method	Description
`TransferCreateRequest`	`accessToken(java.lang.String accessToken)`
`TransferCreateRequest`	`accountId(java.lang.String accountId)`
`TransferCreateRequest`	`achClass(ACHClass achClass)`
`TransferCreateRequest`	`amount(java.lang.String amount)`
`TransferCreateRequest`	`authorizationId(java.lang.String authorizationId)`
`TransferCreateRequest`	`clientId(java.lang.String clientId)`
`TransferCreateRequest`	`description(java.lang.String description)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getAccessToken()`	The Plaid `access_token` for the account that will be debited or credited.
`java.lang.String`	`getAccountId()`	The Plaid `account_id` for the account that will be debited or credited.
`ACHClass`	`getAchClass()`	Get achClass
`java.lang.String`	`getAmount()`	The amount of the transfer (decimal string with two digits of precision e.g.
`java.lang.String`	`getAuthorizationId()`	Plaid’s unique identifier for a transfer authorization.
`java.lang.String`	`getClientId()`	Your Plaid API `client_id`.
`java.lang.String`	`getDescription()`	The transfer description.
`java.lang.String`	`getIdempotencyKey()`	A random key provided by the client, per unique transfer.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()`	The Metadata object is a mapping of client-provided string fields to any string value.
`TransferNetwork`	`getNetwork()`	Get network
`java.lang.String`	`getOriginationAccountId()`	Plaid’s unique identifier for the origination account for this transfer.
`java.lang.String`	`getSecret()`	Your Plaid API `secret`.
`TransferType`	`getType()`	Get type
`TransferUserInRequest`	`getUser()`	Get user
`int`	`hashCode()`
`TransferCreateRequest`	`idempotencyKey(java.lang.String idempotencyKey)`
`TransferCreateRequest`	`metadata(java.util.Map<java.lang.String,java.lang.String> metadata)`
`TransferCreateRequest`	`network(TransferNetwork network)`
`TransferCreateRequest`	`originationAccountId(java.lang.String originationAccountId)`
`TransferCreateRequest`	`putMetadataItem(java.lang.String key, java.lang.String metadataItem)`
`TransferCreateRequest`	`secret(java.lang.String secret)`
`void`	`setAccessToken(java.lang.String accessToken)`
`void`	`setAccountId(java.lang.String accountId)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(java.lang.String amount)`
`void`	`setAuthorizationId(java.lang.String authorizationId)`
`void`	`setClientId(java.lang.String clientId)`
`void`	`setDescription(java.lang.String description)`
`void`	`setIdempotencyKey(java.lang.String idempotencyKey)`
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)`
`void`	`setNetwork(TransferNetwork network)`
`void`	`setOriginationAccountId(java.lang.String originationAccountId)`
`void`	`setSecret(java.lang.String secret)`
`void`	`setType(TransferType type)`
`void`	`setUser(TransferUserInRequest user)`
`java.lang.String`	`toString()`
`TransferCreateRequest`	`type(TransferType type)`
`TransferCreateRequest`	`user(TransferUserInRequest user)`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- SERIALIZED_NAME_CLIENT_ID
  
  public static final java.lang.String SERIALIZED_NAME_CLIENT_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_SECRET
  
  public static final java.lang.String SERIALIZED_NAME_SECRET
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_IDEMPOTENCY_KEY
  
  public static final java.lang.String SERIALIZED_NAME_IDEMPOTENCY_KEY
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ACCESS_TOKEN
  
  public static final java.lang.String SERIALIZED_NAME_ACCESS_TOKEN
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ACCOUNT_ID
  
  public static final java.lang.String SERIALIZED_NAME_ACCOUNT_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_AUTHORIZATION_ID
  
  public static final java.lang.String SERIALIZED_NAME_AUTHORIZATION_ID
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_TYPE
  
  public static final java.lang.String SERIALIZED_NAME_TYPE
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_NETWORK
  
  public static final java.lang.String SERIALIZED_NAME_NETWORK
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_AMOUNT
  
  public static final java.lang.String SERIALIZED_NAME_AMOUNT
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_DESCRIPTION
  
  public static final java.lang.String SERIALIZED_NAME_DESCRIPTION
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ACH_CLASS
  
  public static final java.lang.String SERIALIZED_NAME_ACH_CLASS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_USER
  
  public static final java.lang.String SERIALIZED_NAME_USER
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_METADATA
  
  public static final java.lang.String SERIALIZED_NAME_METADATA
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
  
  public static final java.lang.String SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
  
  See Also:
  
  Constant Field Values
Constructor Details
- TransferCreateRequest
  
  public TransferCreateRequest()
Method Details
- clientId
  
  public TransferCreateRequest clientId(java.lang.String clientId)
- getClientId
  
  @Nullable public java.lang.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(java.lang.String clientId)
- secret
  
  public TransferCreateRequest secret(java.lang.String secret)
- getSecret
  
  @Nullable public java.lang.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(java.lang.String secret)
- idempotencyKey
  
  public TransferCreateRequest idempotencyKey(java.lang.String idempotencyKey)
- getIdempotencyKey
  
  public java.lang.String getIdempotencyKey()
  
  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(java.lang.String idempotencyKey)
- accessToken
  
  public TransferCreateRequest accessToken(java.lang.String accessToken)
- getAccessToken
  
  public java.lang.String getAccessToken()
  
  The Plaid `access_token` for the account that will be debited or credited.
  
  Returns:
  
  accessToken
- setAccessToken
  
  public void setAccessToken(java.lang.String accessToken)
- accountId
  
  public TransferCreateRequest accountId(java.lang.String accountId)
- getAccountId
  
  public java.lang.String getAccountId()
  
  The Plaid `account_id` for the account that will be debited or credited.
  
  Returns:
  
  accountId
- setAccountId
  
  public void setAccountId(java.lang.String accountId)
- authorizationId
  
  public TransferCreateRequest authorizationId(java.lang.String authorizationId)
- getAuthorizationId
  
  public java.lang.String getAuthorizationId()
  
  Plaid’s unique identifier for a transfer authorization.
  
  Returns:
  
  authorizationId
- setAuthorizationId
  
  public void setAuthorizationId(java.lang.String authorizationId)
- type
  
  public TransferCreateRequest type(TransferType type)
- getType
  
  public TransferType getType()
  
  Get type
  
  Returns:
  
  type
- setType
  
  public void setType(TransferType type)
- network
  
  public TransferCreateRequest network(TransferNetwork network)
- getNetwork
  
  public TransferNetwork getNetwork()
  
  Get network
  
  Returns:
  
  network
- setNetwork
  
  public void setNetwork(TransferNetwork network)
- amount
  
  public TransferCreateRequest amount(java.lang.String amount)
- getAmount
  
  public java.lang.String getAmount()
  
  The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).
  
  Returns:
  
  amount
- setAmount
  
  public void setAmount(java.lang.String amount)
- description
  
  public TransferCreateRequest description(java.lang.String description)
- getDescription
  
  public java.lang.String getDescription()
  
  The transfer description. Maximum of 10 characters.
  
  Returns:
  
  description
- setDescription
  
  public void setDescription(java.lang.String description)
- achClass
  
  public TransferCreateRequest achClass(ACHClass achClass)
- getAchClass
  
  public ACHClass getAchClass()
  
  Get achClass
  
  Returns:
  
  achClass
- setAchClass
  
  public void setAchClass(ACHClass achClass)
- user
  
  public TransferCreateRequest user(TransferUserInRequest user)
- getUser
  
  public TransferUserInRequest getUser()
  
  Get user
  
  Returns:
  
  user
- setUser
  
  public void setUser(TransferUserInRequest user)
- metadata
  
  public TransferCreateRequest metadata(java.util.Map<java.lang.String,java.lang.String> metadata)
- putMetadataItem
  
  public TransferCreateRequest putMetadataItem(java.lang.String key, java.lang.String metadataItem)
- getMetadata
  
  @Nullable public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> metadata)
- originationAccountId
  
  public TransferCreateRequest originationAccountId(java.lang.String originationAccountId)
- getOriginationAccountId
  
  @Nullable public java.lang.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.
  
  Returns:
  
  originationAccountId
- setOriginationAccountId
  
  public void setOriginationAccountId(java.lang.String originationAccountId)
- equals
  
  public boolean equals(java.lang.Object o)
  
  Overrides:
  
  equals in class java.lang.Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class TransferCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details