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

Class CreateJITSettlementRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.CreateJITSettlementRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateJITSettlementRequest extends Object implements Serializable
Request to create a new settlement. All transfers included must use the same source account, and the total amount received must be in the same currency as the base currency of the source account.
See Also:

  • Field Details

  • Constructor Details

    • CreateJITSettlementRequest

      public CreateJITSettlementRequest()

  • Method Details

    • accounts

      public CreateJITSettlementRequest accounts(@Nonnull List<SettlementAccount> accounts)

    • addAccountsItem

      public CreateJITSettlementRequest addAccountsItem(SettlementAccount accountsItem)

    • getAccounts

      @Nonnull public List<SettlementAccount> getAccounts()
      Get accounts
      Returns:
      accounts

    • setAccounts

      public void setAccounts(@Nonnull List<SettlementAccount> accounts)

    • additionalInfo

      public CreateJITSettlementRequest additionalInfo(@Nullable String additionalInfo)

    • getAdditionalInfo

      @Nullable public String getAdditionalInfo()
      Additional remittance information. Include if the funding source may require additional information to associate to the source account or settlement.
      Returns:
      additionalInfo

    • setAdditionalInfo

      public void setAdditionalInfo(@Nullable String additionalInfo)

    • assetClass

      public CreateJITSettlementRequest assetClass(@Nonnull JITAssetClass assetClass)

    • getAssetClass

      @Nonnull public JITAssetClass getAssetClass()
      Get assetClass
      Returns:
      assetClass

    • setAssetClass

      public void setAssetClass(@Nonnull JITAssetClass assetClass)

    • currency

      public CreateJITSettlementRequest currency(@Nonnull String currency)

    • getCurrency

      @Nonnull public String getCurrency()
      The currency of the settlement. All accounts identified should have this base currency.
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nonnull String currency)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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