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

Class CreateTransferRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.CreateTransferRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateTransferRequest extends Object implements Serializable
[See main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#creating-a-transfer-entity)
See Also:

  • Field Details

  • Constructor Details

    • CreateTransferRequest

      public CreateTransferRequest()

  • Method Details

    • additionalInformation

      public CreateTransferRequest additionalInformation(@Nullable String additionalInformation)

    • getAdditionalInformation

      @Nullable public String getAdditionalInformation()
      Additional details for when type = `wire`
      Returns:
      additionalInformation

    • setAdditionalInformation

      public void setAdditionalInformation(@Nullable String additionalInformation)

    • amount

      public CreateTransferRequest amount(@Nonnull BigDecimal amount)

    • getAmount

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

    • setAmount

      public void setAmount(@Nonnull BigDecimal amount)

    • bankId

      public CreateTransferRequest bankId(@Nullable UUID bankId)

    • getBankId

      @Nullable public UUID getBankId()
      Required if type = `wire` The bank_relationship created for the account_id [here](https://alpaca.markets/docs/api-references/broker-api/funding/bank/#creating-a-new-bank-relationship)
      Returns:
      bankId

    • setBankId

      public void setBankId(@Nullable UUID bankId)

    • direction

      public CreateTransferRequest direction(@Nonnull TransferDirection direction)

    • getDirection

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

    • setDirection

      public void setDirection(@Nonnull TransferDirection direction)

    • feePaymentMethod

      public CreateTransferRequest feePaymentMethod(@Nullable String feePaymentMethod)

    • getFeePaymentMethod

      @Nullable public String getFeePaymentMethod()
      Only outgoing wire fees are currently supported for automated processing. **user** The end user will pay any applicable fees **invoice** Any applicable fees will be billed to the client in the following monthly invoice
      Returns:
      feePaymentMethod

    • setFeePaymentMethod

      public void setFeePaymentMethod(@Nullable String feePaymentMethod)

    • ira

      public CreateTransferRequest ira(@Nullable TransferIRA ira)

    • getIra

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

    • setIra

      public void setIra(@Nullable TransferIRA ira)

    • relationshipId

      public CreateTransferRequest relationshipId(@Nullable UUID relationshipId)

    • getRelationshipId

      @Nullable public UUID getRelationshipId()
      Required if type = `ach` The ach_relationship created for the account_id [here](https://alpaca.markets/docs/api-references/broker-api/funding/ach/#creating-an-ach-relationship)
      Returns:
      relationshipId

    • setRelationshipId

      public void setRelationshipId(@Nullable UUID relationshipId)

    • timing

      @Deprecated public CreateTransferRequest timing(@Nullable CreateTransferRequest.TimingEnum timing)
      Deprecated.

    • getTiming

      @Deprecated @Nullable public CreateTransferRequest.TimingEnum getTiming()
      Deprecated.
      Deprecated. Not honored by the API; values sent are silently ignored and this field will be removed.
      Returns:
      timing

    • setTiming

      @Deprecated public void setTiming(@Nullable CreateTransferRequest.TimingEnum timing)
      Deprecated.

    • transferType

      public CreateTransferRequest transferType(@Nonnull TransferType transferType)

    • getTransferType

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

    • setTransferType

      public void setTransferType(@Nonnull TransferType transferType)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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