java.lang.Object

com.plaid.client.model.BankTransfer

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

Represents a bank transfer within the Bank Transfers API.

Field Summary

Fields
Modifier and Type	Field	Description
`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_CANCELLABLE`
`static java.lang.String`	`SERIALIZED_NAME_CREATED`
`static java.lang.String`	`SERIALIZED_NAME_CUSTOM_TAG`
`static java.lang.String`	`SERIALIZED_NAME_DESCRIPTION`
`static java.lang.String`	`SERIALIZED_NAME_DIRECTION`
`static java.lang.String`	`SERIALIZED_NAME_FAILURE_REASON`
`static java.lang.String`	`SERIALIZED_NAME_ID`
`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_STATUS`
`static java.lang.String`	`SERIALIZED_NAME_TYPE`
`static java.lang.String`	`SERIALIZED_NAME_USER`

Constructor Summary

Constructors

Constructor Description

BankTransfer()

Method Summary

Modifier and Type	Method	Description
`BankTransfer`	`accountId(java.lang.String accountId)`
`BankTransfer`	`achClass(ACHClass achClass)`
`BankTransfer`	`amount(java.lang.String amount)`
`BankTransfer`	`cancellable(java.lang.Boolean cancellable)`
`BankTransfer`	`created(java.time.OffsetDateTime created)`
`BankTransfer`	`customTag(java.lang.String customTag)`
`BankTransfer`	`description(java.lang.String description)`
`BankTransfer`	`direction(BankTransferDirection direction)`
`boolean`	`equals(java.lang.Object o)`
`BankTransfer`	`failureReason(BankTransferFailure failureReason)`
`java.lang.String`	`getAccountId()`	The account ID that should be credited/debited for this bank transfer.
`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.Boolean`	`getCancellable()`	When `true`, you can still cancel this bank transfer.
`java.time.OffsetDateTime`	`getCreated()`	The datetime when this bank transfer was created.
`java.lang.String`	`getCustomTag()`	A string containing the custom tag provided by the client in the create request.
`java.lang.String`	`getDescription()`	The description of the transfer.
`BankTransferDirection`	`getDirection()`	Get direction
`BankTransferFailure`	`getFailureReason()`	Get failureReason
`java.lang.String`	`getId()`	Plaid’s unique identifier for a bank transfer.
`java.lang.String`	`getIsoCurrencyCode()`	The currency of the transfer amount, e.g.
`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 that was used for this transfer.
`BankTransferStatus`	`getStatus()`	Get status
`BankTransferType`	`getType()`	Get type
`BankTransferUser`	`getUser()`	Get user
`int`	`hashCode()`
`BankTransfer`	`id(java.lang.String id)`
`BankTransfer`	`isoCurrencyCode(java.lang.String isoCurrencyCode)`
`BankTransfer`	`metadata(java.util.Map<java.lang.String,java.lang.String> metadata)`
`BankTransfer`	`network(BankTransferNetwork network)`
`BankTransfer`	`originationAccountId(java.lang.String originationAccountId)`
`BankTransfer`	`putMetadataItem(java.lang.String key, java.lang.String metadataItem)`
`void`	`setAccountId(java.lang.String accountId)`
`void`	`setAchClass(ACHClass achClass)`
`void`	`setAmount(java.lang.String amount)`
`void`	`setCancellable(java.lang.Boolean cancellable)`
`void`	`setCreated(java.time.OffsetDateTime created)`
`void`	`setCustomTag(java.lang.String customTag)`
`void`	`setDescription(java.lang.String description)`
`void`	`setDirection(BankTransferDirection direction)`
`void`	`setFailureReason(BankTransferFailure failureReason)`
`void`	`setId(java.lang.String id)`
`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`	`setStatus(BankTransferStatus status)`
`void`	`setType(BankTransferType type)`
`void`	`setUser(BankTransferUser user)`
`BankTransfer`	`status(BankTransferStatus status)`
`java.lang.String`	`toString()`
`BankTransfer`	`type(BankTransferType type)`
`BankTransfer`	`user(BankTransferUser user)`

Methods inherited from class java.lang.Object

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

Field Details
- SERIALIZED_NAME_ID
  
  public static final java.lang.String SERIALIZED_NAME_ID
  
  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_ACCOUNT_ID
  
  public static final java.lang.String SERIALIZED_NAME_ACCOUNT_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_USER
  
  public static final java.lang.String SERIALIZED_NAME_USER
  
  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_CREATED
  
  public static final java.lang.String SERIALIZED_NAME_CREATED
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_STATUS
  
  public static final java.lang.String SERIALIZED_NAME_STATUS
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_NETWORK
  
  public static final java.lang.String SERIALIZED_NAME_NETWORK
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_CANCELLABLE
  
  public static final java.lang.String SERIALIZED_NAME_CANCELLABLE
  
  See Also:
  
  Constant Field Values
- SERIALIZED_NAME_FAILURE_REASON
  
  public static final java.lang.String SERIALIZED_NAME_FAILURE_REASON
  
  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
- SERIALIZED_NAME_DIRECTION
  
  public static final java.lang.String SERIALIZED_NAME_DIRECTION
  
  See Also:
  
  Constant Field Values
Constructor Details
- BankTransfer
  
  public BankTransfer()
Method Details
- id
  
  public BankTransfer id(java.lang.String id)
- getId
  
  public java.lang.String getId()
  
  Plaid’s unique identifier for a bank transfer.
  
  Returns:
  
  id
- setId
  
  public void setId(java.lang.String id)
- achClass
  
  public BankTransfer achClass(ACHClass achClass)
- getAchClass
  
  public ACHClass getAchClass()
  
  Get achClass
  
  Returns:
  
  achClass
- setAchClass
  
  public void setAchClass(ACHClass achClass)
- accountId
  
  public BankTransfer accountId(java.lang.String accountId)
- getAccountId
  
  public java.lang.String getAccountId()
  
  The account ID that should be credited/debited for this bank transfer.
  
  Returns:
  
  accountId
- setAccountId
  
  public void setAccountId(java.lang.String accountId)
- type
  
  public BankTransfer type(BankTransferType type)
- getType
  
  public BankTransferType getType()
  
  Get type
  
  Returns:
  
  type
- setType
  
  public void setType(BankTransferType type)
- user
  
  public BankTransfer user(BankTransferUser user)
- getUser
  
  public BankTransferUser getUser()
  
  Get user
  
  Returns:
  
  user
- setUser
  
  public void setUser(BankTransferUser user)
- amount
  
  public BankTransfer 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 BankTransfer isoCurrencyCode(java.lang.String isoCurrencyCode)
- getIsoCurrencyCode
  
  public java.lang.String getIsoCurrencyCode()
  
  The currency of the transfer amount, e.g. \"USD\"
  
  Returns:
  
  isoCurrencyCode
- setIsoCurrencyCode
  
  public void setIsoCurrencyCode(java.lang.String isoCurrencyCode)
- description
  
  public BankTransfer description(java.lang.String description)
- getDescription
  
  public java.lang.String getDescription()
  
  The description of the transfer.
  
  Returns:
  
  description
- setDescription
  
  public void setDescription(java.lang.String description)
- created
  
  public BankTransfer created(java.time.OffsetDateTime created)
- getCreated
  
  public java.time.OffsetDateTime getCreated()
  
  The datetime when this bank transfer was created. This will be of the form `2006-01-02T15:04:05Z`
  
  Returns:
  
  created
- setCreated
  
  public void setCreated(java.time.OffsetDateTime created)
- status
  
  public BankTransfer status(BankTransferStatus status)
- getStatus
  
  public BankTransferStatus getStatus()
  
  Get status
  
  Returns:
  
  status
- setStatus
  
  public void setStatus(BankTransferStatus status)
- network
  
  public BankTransfer network(BankTransferNetwork network)
- getNetwork
  
  public BankTransferNetwork getNetwork()
  
  Get network
  
  Returns:
  
  network
- setNetwork
  
  public void setNetwork(BankTransferNetwork network)
- cancellable
  
  public BankTransfer cancellable(java.lang.Boolean cancellable)
- getCancellable
  
  public java.lang.Boolean getCancellable()
  
  When `true`, you can still cancel this bank transfer.
  
  Returns:
  
  cancellable
- setCancellable
  
  public void setCancellable(java.lang.Boolean cancellable)
- failureReason
  
  public BankTransfer failureReason(BankTransferFailure failureReason)
- getFailureReason
  
  @Nullable public BankTransferFailure getFailureReason()
  
  Get failureReason
  
  Returns:
  
  failureReason
- setFailureReason
  
  public void setFailureReason(BankTransferFailure failureReason)
- customTag
  
  public BankTransfer customTag(java.lang.String customTag)
- getCustomTag
  
  @Nullable public java.lang.String getCustomTag()
  
  A string containing the custom tag provided by the client in the create request. Will be null if not provided.
  
  Returns:
  
  customTag
- setCustomTag
  
  public void setCustomTag(java.lang.String customTag)
- metadata
  
  public BankTransfer metadata(java.util.Map<java.lang.String,java.lang.String> metadata)
- putMetadataItem
  
  public BankTransfer 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 BankTransfer originationAccountId(java.lang.String originationAccountId)
- getOriginationAccountId
  
  public java.lang.String getOriginationAccountId()
  
  Plaid’s unique identifier for the origination account that was used for this transfer.
  
  Returns:
  
  originationAccountId
- setOriginationAccountId
  
  public void setOriginationAccountId(java.lang.String originationAccountId)
- direction
  
  public BankTransfer direction(BankTransferDirection direction)
- getDirection
  
  @Nullable public BankTransferDirection getDirection()
  
  Get direction
  
  Returns:
  
  direction
- setDirection
  
  public void setDirection(BankTransferDirection direction)
- 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 BankTransfer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details