java.lang.Object

com.plaid.client.model.ProcessorBankTransferCreateRequest

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

Defines the request schema for `/processor/bank_transfer/create`

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`SERIALIZED_NAME_ACH_CLASS`
`static java.lang.String`	`SERIALIZED_NAME_AMOUNT`
`static java.lang.String`	`SERIALIZED_NAME_CLIENT_ID`
`static java.lang.String`	`SERIALIZED_NAME_CUSTOM_TAG`
`static java.lang.String`	`SERIALIZED_NAME_DESCRIPTION`
`static java.lang.String`	`SERIALIZED_NAME_IDEMPOTENCY_KEY`
`static java.lang.String`	`SERIALIZED_NAME_ISO_CURRENCY_CODE`
`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_PROCESSOR_TOKEN`
`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

ProcessorBankTransferCreateRequest()

Method Summary

Modifier and Type	Method	Description
`ProcessorBankTransferCreateRequest`	`achClass(ACHClass achClass)`
`ProcessorBankTransferCreateRequest`	`amount(java.lang.String amount)`
`ProcessorBankTransferCreateRequest`	`clientId(java.lang.String clientId)`
`ProcessorBankTransferCreateRequest`	`customTag(java.lang.String customTag)`
`ProcessorBankTransferCreateRequest`	`description(java.lang.String description)`
`boolean`	`equals(java.lang.Object o)`
`ACHClass`	`getAchClass()`	Get achClass
`java.lang.String`	`getAmount()`	The amount of the bank transfer (decimal string with two digits of precision e.g.
`java.lang.String`	`getClientId()`	Your Plaid API `client_id`.
`java.lang.String`	`getCustomTag()`	An arbitrary string provided by the client for storage with the bank transfer.
`java.lang.String`	`getDescription()`	The transfer description.
`java.lang.String`	`getIdempotencyKey()`	A random key provided by the client, per unique bank transfer.
`java.lang.String`	`getIsoCurrencyCode()`	The currency of the transfer amount – should be set to \"USD\".
`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.
`BankTransferNetwork`	`getNetwork()`	Get network
`java.lang.String`	`getOriginationAccountId()`	Plaid’s unique identifier for the origination account for this transfer.
`java.lang.String`	`getProcessorToken()`	The processor token obtained from the Plaid integration partner.
`java.lang.String`	`getSecret()`	Your Plaid API `secret`.
`BankTransferType`	`getType()`	Get type
`BankTransferUser`	`getUser()`	Get user
`int`	`hashCode()`
`ProcessorBankTransferCreateRequest`	`idempotencyKey(java.lang.String idempotencyKey)`
`ProcessorBankTransferCreateRequest`	`isoCurrencyCode(java.lang.String isoCurrencyCode)`
`ProcessorBankTransferCreateRequest`	`metadata(java.util.Map<java.lang.String,java.lang.String> metadata)`
`ProcessorBankTransferCreateRequest`	`network(BankTransferNetwork network)`
`ProcessorBankTransferCreateRequest`	`originationAccountId(java.lang.String originationAccountId)`
`ProcessorBankTransferCreateRequest`	`processorToken(java.lang.String processorToken)`
`ProcessorBankTransferCreateRequest`	`putMetadataItem(java.lang.String key, java.lang.String metadataItem)`
`ProcessorBankTransferCreateRequest`	`secret(java.lang.String secret)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(java.lang.String amount)`
`void`	`setClientId(java.lang.String clientId)`
`void`	`setCustomTag(java.lang.String customTag)`
`void`	`setDescription(java.lang.String description)`
`void`	`setIdempotencyKey(java.lang.String idempotencyKey)`
`void`	`setIsoCurrencyCode(java.lang.String isoCurrencyCode)`
`void`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)`
`void`	`setNetwork(BankTransferNetwork network)`
`void`	`setOriginationAccountId(java.lang.String originationAccountId)`
`void`	`setProcessorToken(java.lang.String processorToken)`
`void`	`setSecret(java.lang.String secret)`
`void`	`setType(BankTransferType type)`
`void`	`setUser(BankTransferUser user)`
`java.lang.String`	`toString()`
`ProcessorBankTransferCreateRequest`	`type(BankTransferType type)`
`ProcessorBankTransferCreateRequest`	`user(BankTransferUser 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_PROCESSOR_TOKEN
  
  public static final java.lang.String SERIALIZED_NAME_PROCESSOR_TOKEN
  
  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_ISO_CURRENCY_CODE
  
  public static final java.lang.String SERIALIZED_NAME_ISO_CURRENCY_CODE
  
  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_CUSTOM_TAG
  
  public static final java.lang.String SERIALIZED_NAME_CUSTOM_TAG
  
  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
- ProcessorBankTransferCreateRequest
  
  public ProcessorBankTransferCreateRequest()
Method Details
- clientId
  
  public ProcessorBankTransferCreateRequest 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 ProcessorBankTransferCreateRequest 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 ProcessorBankTransferCreateRequest idempotencyKey(java.lang.String idempotencyKey)
- getIdempotencyKey
  
  public java.lang.String getIdempotencyKey()
  
  A random key provided by the client, per unique bank 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 bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.
  
  Returns:
  
  idempotencyKey
- setIdempotencyKey
  
  public void setIdempotencyKey(java.lang.String idempotencyKey)
- processorToken
  
  public ProcessorBankTransferCreateRequest processorToken(java.lang.String processorToken)
- getProcessorToken
  
  public java.lang.String getProcessorToken()
  
  The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
  
  Returns:
  
  processorToken
- setProcessorToken
  
  public void setProcessorToken(java.lang.String processorToken)
- type
  
  public ProcessorBankTransferCreateRequest type(BankTransferType type)
- getType
  
  public BankTransferType getType()
  
  Get type
  
  Returns:
  
  type
- setType
  
  public void setType(BankTransferType type)
- network
  
  public ProcessorBankTransferCreateRequest network(BankTransferNetwork network)
- getNetwork
  
  public BankTransferNetwork getNetwork()
  
  Get network
  
  Returns:
  
  network
- setNetwork
  
  public void setNetwork(BankTransferNetwork network)
- amount
  
  public ProcessorBankTransferCreateRequest amount(java.lang.String amount)
- getAmount
  
  public java.lang.String getAmount()
  
  The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).
  
  Returns:
  
  amount
- setAmount
  
  public void setAmount(java.lang.String amount)
- isoCurrencyCode
  
  public ProcessorBankTransferCreateRequest isoCurrencyCode(java.lang.String isoCurrencyCode)
- getIsoCurrencyCode
  
  public java.lang.String getIsoCurrencyCode()
  
  The currency of the transfer amount – should be set to \"USD\".
  
  Returns:
  
  isoCurrencyCode
- setIsoCurrencyCode
  
  public void setIsoCurrencyCode(java.lang.String isoCurrencyCode)
- description
  
  public ProcessorBankTransferCreateRequest 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 ProcessorBankTransferCreateRequest achClass(ACHClass achClass)
- getAchClass
  
  @Nullable public ACHClass getAchClass()
  
  Get achClass
  
  Returns:
  
  achClass
- setAchClass
  
  public void setAchClass(ACHClass achClass)
- user
  
  public ProcessorBankTransferCreateRequest user(BankTransferUser user)
- getUser
  
  public BankTransferUser getUser()
  
  Get user
  
  Returns:
  
  user
- setUser
  
  public void setUser(BankTransferUser user)
- customTag
  
  public ProcessorBankTransferCreateRequest customTag(java.lang.String customTag)
- getCustomTag
  
  @Nullable public java.lang.String getCustomTag()
  
  An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.
  
  Returns:
  
  customTag
- setCustomTag
  
  public void setCustomTag(java.lang.String customTag)
- metadata
  
  public ProcessorBankTransferCreateRequest metadata(java.util.Map<java.lang.String,java.lang.String> metadata)
- putMetadataItem
  
  public ProcessorBankTransferCreateRequest 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 ProcessorBankTransferCreateRequest 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 ProcessorBankTransferCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details