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

Class CreateSettlementRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.CreateSettlementRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateSettlementRequest 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 as well as the transmitter information.
See Also:

  • Field Details

  • Constructor Details

    • CreateSettlementRequest

      public CreateSettlementRequest()

  • Method Details

    • additionalInfo

      public CreateSettlementRequest 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)

    • transfers

      public CreateSettlementRequest transfers(@Nonnull List<SettlementTransfer> transfers)

    • addTransfersItem

      public CreateSettlementRequest addTransfersItem(SettlementTransfer transfersItem)

    • getTransfers

      @Nonnull public List<SettlementTransfer> getTransfers()
      Get transfers
      Returns:
      transfers

    • setTransfers

      public void setTransfers(@Nonnull List<SettlementTransfer> transfers)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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