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

Class AcatsInitiateTransferRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.AcatsInitiateTransferRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class AcatsInitiateTransferRequest extends Object implements Serializable
Request body for initiating an incoming ACATS transfer.
See Also:

  • Field Details

  • Constructor Details

    • AcatsInitiateTransferRequest

      public AcatsInitiateTransferRequest()

  • Method Details

    • contraAccountDetails

      public AcatsInitiateTransferRequest contraAccountDetails(@Nonnull AcatsContraAccountDetails contraAccountDetails)

    • getContraAccountDetails

      @Nonnull public AcatsContraAccountDetails getContraAccountDetails()
      Get contraAccountDetails
      Returns:
      contraAccountDetails

    • setContraAccountDetails

      public void setContraAccountDetails(@Nonnull AcatsContraAccountDetails contraAccountDetails)

    • ipAddress

      public AcatsInitiateTransferRequest ipAddress(@Nonnull String ipAddress)

    • getIpAddress

      @Nonnull public String getIpAddress()
      IP address from which the account holder initiated the transfer (IPv4 or IPv6)
      Returns:
      ipAddress

    • setIpAddress

      public void setIpAddress(@Nonnull String ipAddress)

    • signedAt

      public AcatsInitiateTransferRequest signedAt(@Nonnull OffsetDateTime signedAt)

    • getSignedAt

      @Nonnull public OffsetDateTime getSignedAt()
      Timestamp at which the account holder signed/authorized the transfer. Must be within the last week and must not be in the future (a 5 minute grace period absorbs clock skew); values outside that window are rejected with HTTP 400.
      Returns:
      signedAt

    • setSignedAt

      public void setSignedAt(@Nonnull OffsetDateTime signedAt)

    • transferDetails

      public AcatsInitiateTransferRequest transferDetails(@Nonnull AcatsInitiateTransferDetails transferDetails)

    • getTransferDetails

      @Nonnull public AcatsInitiateTransferDetails getTransferDetails()
      Get transferDetails
      Returns:
      transferDetails

    • setTransferDetails

      public void setTransferDetails(@Nonnull AcatsInitiateTransferDetails transferDetails)

    • validateAccountNumber

      public AcatsInitiateTransferRequest validateAccountNumber(@Nullable Boolean validateAccountNumber)

    • getValidateAccountNumber

      @Nullable public Boolean getValidateAccountNumber()
      Whether to validate the contra account number against the contra broker's configured format rules. Defaults to false (no per-broker format check). Set to true to opt in, in which case a number that matches none of the broker's enabled rules is rejected with HTTP 422.
      Returns:
      validateAccountNumber

    • setValidateAccountNumber

      public void setValidateAccountNumber(@Nullable Boolean validateAccountNumber)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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