Package markets.alpaca.client.openapi.broker.model

Class Transfer

java.lang.Object
markets.alpaca.client.openapi.broker.model.Transfer
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Transfer extends Object implements Serializable
Transfers allow you to transfer money/balance into your end customers' account (deposits) or out (withdrawal). [Main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#the-transfer-object)
See Also:

  • Field Details

  • Constructor Details

    • Transfer

      public Transfer()

  • Method Details

    • accountId

      public Transfer accountId(@Nonnull UUID accountId)

    • getAccountId

      @Nonnull public UUID getAccountId()
      The account ID
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nonnull UUID accountId)

    • additionalInformation

      public Transfer additionalInformation(@Nullable String additionalInformation)

    • getAdditionalInformation

      @Nullable public String getAdditionalInformation()
      Additional information. Only applies when type = \"wire\".
      Returns:
      additionalInformation

    • setAdditionalInformation

      public void setAdditionalInformation(@Nullable String additionalInformation)

    • amount

      public Transfer amount(@Nonnull BigDecimal amount)

    • getAmount

      @Nonnull public BigDecimal getAmount()
      Must be > 0.00
      Returns:
      amount

    • setAmount

      public void setAmount(@Nonnull BigDecimal amount)

    • bankId

      public Transfer bankId(@Nullable UUID bankId)

    • getBankId

      @Nullable public UUID getBankId()
      The ID of the Bank, only present if type = \"wire\"
      Returns:
      bankId

    • setBankId

      public void setBankId(@Nullable UUID bankId)

    • createdAt

      public Transfer createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      Timestamp when transfer was created
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • direction

      public Transfer direction(@Nonnull TransferDirection direction)

    • getDirection

      @Nonnull public TransferDirection getDirection()
      Get direction
      Returns:
      direction

    • setDirection

      public void setDirection(@Nonnull TransferDirection direction)

    • expiresAt

      public Transfer expiresAt(@Nullable OffsetDateTime expiresAt)

    • getExpiresAt

      @Nullable public OffsetDateTime getExpiresAt()
      Timestamp when transfer expires
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable OffsetDateTime expiresAt)

    • fee

      public Transfer fee(@Nullable BigDecimal fee)

    • getFee

      @Nullable public BigDecimal getFee()
      Fee amount to be collected. Only applies when type = \"wire\".
      Returns:
      fee

    • setFee

      public void setFee(@Nullable BigDecimal fee)

    • feePaymentMethod

      public Transfer feePaymentMethod(@Nullable String feePaymentMethod)

    • getFeePaymentMethod

      @Nullable public String getFeePaymentMethod()
      Either \"user\" or \"invoice\". Only applies when type = \"wire\".
      Returns:
      feePaymentMethod

    • setFeePaymentMethod

      public void setFeePaymentMethod(@Nullable String feePaymentMethod)

    • holdUntil

      public Transfer holdUntil(@Nullable OffsetDateTime holdUntil)

    • getHoldUntil

      @Nullable public OffsetDateTime getHoldUntil()
      Get holdUntil
      Returns:
      holdUntil

    • setHoldUntil

      public void setHoldUntil(@Nullable OffsetDateTime holdUntil)

    • id

      public Transfer id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      The transfer ID
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • instantAmount

      public Transfer instantAmount(@Nullable String instantAmount)

    • getInstantAmount

      @Nullable public String getInstantAmount()
      Get instantAmount
      Returns:
      instantAmount

    • setInstantAmount

      public void setInstantAmount(@Nullable String instantAmount)

    • ira

      public Transfer ira(@Nullable TransferIRADetails ira)

    • getIra

      @Nullable public TransferIRADetails getIra()
      Get ira
      Returns:
      ira

    • setIra

      public void setIra(@Nullable TransferIRADetails ira)

    • reason

      public Transfer reason(@Nullable String reason)

    • getReason

      @Nullable public String getReason()
      Cause of the status
      Returns:
      reason

    • setReason

      public void setReason(@Nullable String reason)

    • relationshipId

      public Transfer relationshipId(@Nullable UUID relationshipId)

    • getRelationshipId

      @Nullable public UUID getRelationshipId()
      The ACH relationship ID only present if type = \"ach\"
      Returns:
      relationshipId

    • setRelationshipId

      public void setRelationshipId(@Nullable UUID relationshipId)

    • requestedAmount

      public Transfer requestedAmount(@Nullable BigDecimal requestedAmount)

    • getRequestedAmount

      @Nullable public BigDecimal getRequestedAmount()
      Must be > 0.00. Only applies when type = \"wire\".
      Returns:
      requestedAmount

    • setRequestedAmount

      public void setRequestedAmount(@Nullable BigDecimal requestedAmount)

    • status

      public Transfer status(@Nonnull TransferStatus status)

    • getStatus

      @Nonnull public TransferStatus getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull TransferStatus status)

    • type

      public Transfer type(@Nonnull TransferType type)

    • getType

      @Nonnull public TransferType getType()
      Get type
      Returns:
      type

    • setType

      public void setType(@Nonnull TransferType type)

    • updatedAt

      public Transfer updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Timestamp when transfer was updated
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

    • putAdditionalProperty

      public Transfer putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the Transfer instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • 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

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to Transfer

    • fromJson

      public static Transfer fromJson(String jsonString) throws IOException
      Create an instance of Transfer given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of Transfer
      Throws:
      IOException - if the JSON string is invalid with respect to Transfer

    • toJson

      public String toJson()
      Convert an instance of Transfer to an JSON string
      Returns:
      JSON string