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

Class CryptoTransfer

java.lang.Object
markets.alpaca.client.openapi.broker.model.CryptoTransfer
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CryptoTransfer extends Object implements Serializable
Transfers allow you to transfer assets into your end customer's account (deposits) or out (withdrawal).
See Also:

  • Field Details

  • Constructor Details

    • CryptoTransfer

      public CryptoTransfer()

  • Method Details

    • amount

      public CryptoTransfer amount(@Nullable String amount)

    • getAmount

      @Nullable public String getAmount()
      Amount of transfer denominated in the underlying crypto asset
      Returns:
      amount

    • setAmount

      public void setAmount(@Nullable String amount)

    • asset

      public CryptoTransfer asset(@Nullable String asset)

    • getAsset

      @Nullable public String getAsset()
      Symbol of crypto asset for given transfer (e.g. BTC)
      Returns:
      asset

    • setAsset

      public void setAsset(@Nullable String asset)

    • chain

      public CryptoTransfer chain(@Nullable String chain)

    • getChain

      @Nullable public String getChain()
      Underlying network for given transfer
      Returns:
      chain

    • setChain

      public void setChain(@Nullable String chain)

    • createdAt

      public CryptoTransfer createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

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

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • direction

      public CryptoTransfer direction(@Nullable TransferDirection direction)

    • getDirection

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

    • setDirection

      public void setDirection(@Nullable TransferDirection direction)

    • fees

      public CryptoTransfer fees(@Nullable String fees)

    • getFees

      @Nullable public String getFees()
      Get fees
      Returns:
      fees

    • setFees

      public void setFees(@Nullable String fees)

    • fromAddress

      public CryptoTransfer fromAddress(@Nullable String fromAddress)

    • getFromAddress

      @Nullable public String getFromAddress()
      Originating address of the transfer
      Returns:
      fromAddress

    • setFromAddress

      public void setFromAddress(@Nullable String fromAddress)

    • id

      public CryptoTransfer id(@Nullable UUID id)

    • getId

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

    • setId

      public void setId(@Nullable UUID id)

    • networkFee

      public CryptoTransfer networkFee(@Nullable String networkFee)

    • getNetworkFee

      @Nullable public String getNetworkFee()
      Get networkFee
      Returns:
      networkFee

    • setNetworkFee

      public void setNetworkFee(@Nullable String networkFee)

    • status

      public CryptoTransfer status(@Nullable CryptoTransferStatus status)

    • getStatus

      @Nullable public CryptoTransferStatus getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable CryptoTransferStatus status)

    • toAddress

      public CryptoTransfer toAddress(@Nullable String toAddress)

    • getToAddress

      @Nullable public String getToAddress()
      Destination address of the transfer
      Returns:
      toAddress

    • setToAddress

      public void setToAddress(@Nullable String toAddress)

    • txHash

      public CryptoTransfer txHash(@Nullable String txHash)

    • getTxHash

      @Nullable public String getTxHash()
      On-chain transaction hash (e.g. 0xabc...xyz)
      Returns:
      txHash

    • setTxHash

      public void setTxHash(@Nullable String txHash)

    • usdValue

      public CryptoTransfer usdValue(@Nullable String usdValue)

    • getUsdValue

      @Nullable public String getUsdValue()
      Equivalent USD value at time of transfer
      Returns:
      usdValue

    • setUsdValue

      public void setUsdValue(@Nullable String usdValue)

    • putAdditionalProperty

      public CryptoTransfer 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 CryptoTransfer 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 CryptoTransfer

    • fromJson

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

    • toJson

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