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

Class AcatsTransfer

java.lang.Object
markets.alpaca.client.openapi.broker.model.AcatsTransfer
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class AcatsTransfer extends Object implements Serializable
An ACATS transfer and its current status.
See Also:

  • Field Details

  • Constructor Details

    • AcatsTransfer

      public AcatsTransfer()

  • Method Details

    • acatsId

      public AcatsTransfer acatsId(@Nonnull UUID acatsId)

    • getAcatsId

      @Nonnull public UUID getAcatsId()
      The ID of the ACATS transfer
      Returns:
      acatsId

    • setAcatsId

      public void setAcatsId(@Nonnull UUID acatsId)

    • accountId

      public AcatsTransfer accountId(@Nonnull UUID accountId)

    • getAccountId

      @Nonnull public UUID getAccountId()
      Account ID associated with the ACATS transfer
      Returns:
      accountId

    • setAccountId

      public void setAccountId(@Nonnull UUID accountId)

    • accountName

      public AcatsTransfer accountName(@Nullable String accountName)

    • getAccountName

      @Nullable public String getAccountName()
      Name on the Alpaca account associated with the transfer
      Returns:
      accountName

    • setAccountName

      public void setAccountName(@Nullable String accountName)

    • accountNumber

      public AcatsTransfer accountNumber(@Nonnull String accountNumber)

    • getAccountNumber

      @Nonnull public String getAccountNumber()
      Account number at Alpaca
      Returns:
      accountNumber

    • setAccountNumber

      public void setAccountNumber(@Nonnull String accountNumber)

    • accountType

      public AcatsTransfer accountType(@Nullable AcatsAccountType accountType)

    • getAccountType

      @Nullable public AcatsAccountType getAccountType()
      Get accountType
      Returns:
      accountType

    • setAccountType

      public void setAccountType(@Nullable AcatsAccountType accountType)

    • contraAccountNumber

      public AcatsTransfer contraAccountNumber(@Nonnull String contraAccountNumber)

    • getContraAccountNumber

      @Nonnull public String getContraAccountNumber()
      Account number at the contra broker
      Returns:
      contraAccountNumber

    • setContraAccountNumber

      public void setContraAccountNumber(@Nonnull String contraAccountNumber)

    • contraBrokerName

      public AcatsTransfer contraBrokerName(@Nullable String contraBrokerName)

    • getContraBrokerName

      @Nullable public String getContraBrokerName()
      Name of the contra broker
      Returns:
      contraBrokerName

    • setContraBrokerName

      public void setContraBrokerName(@Nullable String contraBrokerName)

    • contraBrokerNumber

      public AcatsTransfer contraBrokerNumber(@Nonnull String contraBrokerNumber)

    • getContraBrokerNumber

      @Nonnull public String getContraBrokerNumber()
      DTCC account number for the contra broker
      Returns:
      contraBrokerNumber

    • setContraBrokerNumber

      public void setContraBrokerNumber(@Nonnull String contraBrokerNumber)

    • contraBrokerType

      public AcatsTransfer contraBrokerType(@Nullable AcatsContraBrokerType contraBrokerType)

    • getContraBrokerType

      @Nullable public AcatsContraBrokerType getContraBrokerType()
      Get contraBrokerType
      Returns:
      contraBrokerType

    • setContraBrokerType

      public void setContraBrokerType(@Nullable AcatsContraBrokerType contraBrokerType)

    • createdAt

      public AcatsTransfer createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      Timestamp in RFC-3339 format with microsecond precision
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • direction

      public AcatsTransfer direction(@Nonnull AcatsTransferDirection direction)

    • getDirection

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

    • setDirection

      public void setDirection(@Nonnull AcatsTransferDirection direction)

    • ipAddress

      public AcatsTransfer ipAddress(@Nullable String ipAddress)

    • getIpAddress

      @Nullable public String getIpAddress()
      User's IP address (IPv4 or IPv6) at time of submission
      Returns:
      ipAddress

    • setIpAddress

      public void setIpAddress(@Nullable String ipAddress)

    • originalTransferIdentifier

      public AcatsTransfer originalTransferIdentifier(@Nullable String originalTransferIdentifier)

    • getOriginalTransferIdentifier

      @Nullable public String getOriginalTransferIdentifier()
      DTCC transfer identifier for a previous, related transfer
      Returns:
      originalTransferIdentifier

    • setOriginalTransferIdentifier

      public void setOriginalTransferIdentifier(@Nullable String originalTransferIdentifier)

    • rejectionDetails

      public AcatsTransfer rejectionDetails(@Nullable AcatsRejectionDetails rejectionDetails)

    • getRejectionDetails

      @Nullable public AcatsRejectionDetails getRejectionDetails()
      Get rejectionDetails
      Returns:
      rejectionDetails

    • setRejectionDetails

      public void setRejectionDetails(@Nullable AcatsRejectionDetails rejectionDetails)

    • settlementDate

      public AcatsTransfer settlementDate(@Nullable OffsetDateTime settlementDate)

    • getSettlementDate

      @Nullable public OffsetDateTime getSettlementDate()
      Timestamp in RFC-3339 format with microsecond precision
      Returns:
      settlementDate

    • setSettlementDate

      public void setSettlementDate(@Nullable OffsetDateTime settlementDate)

    • status

      public AcatsTransfer status(@Nonnull AcatsStatusDetails status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nonnull AcatsStatusDetails status)

    • totalTransferValue

      public AcatsTransfer totalTransferValue(@Nullable BigDecimal totalTransferValue)

    • getTotalTransferValue

      @Nullable public BigDecimal getTotalTransferValue()
      Total transfer value is the sum of the market value of all assets and securities in an ACAT at the time of settlement, plus any cash balance.
      Returns:
      totalTransferValue

    • setTotalTransferValue

      public void setTotalTransferValue(@Nullable BigDecimal totalTransferValue)

    • transferIdentifier

      public AcatsTransfer transferIdentifier(@Nullable String transferIdentifier)

    • getTransferIdentifier

      @Nullable public String getTransferIdentifier()
      DTCC transfer identifier, also known as the control number
      Returns:
      transferIdentifier

    • setTransferIdentifier

      public void setTransferIdentifier(@Nullable String transferIdentifier)

    • transferType

      public AcatsTransfer transferType(@Nonnull AcatsDtccTransferType transferType)

    • getTransferType

      @Nonnull public AcatsDtccTransferType getTransferType()
      Get transferType
      Returns:
      transferType

    • setTransferType

      public void setTransferType(@Nonnull AcatsDtccTransferType transferType)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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