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

Class CreateBankRequest

java.lang.Object
markets.alpaca.client.openapi.broker.model.CreateBankRequest
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateBankRequest extends Object implements Serializable
Represents the possible fields to send when creating a new associated Bank resource for an account
See Also:

  • Field Details

  • Constructor Details

    • CreateBankRequest

      public CreateBankRequest()

  • Method Details

    • accountNumber

      public CreateBankRequest accountNumber(@Nonnull String accountNumber)

    • getAccountNumber

      @Nonnull public String getAccountNumber()
      Get accountNumber
      Returns:
      accountNumber

    • setAccountNumber

      public void setAccountNumber(@Nonnull String accountNumber)

    • bankCode

      public CreateBankRequest bankCode(@Nonnull String bankCode)

    • getBankCode

      @Nonnull public String getBankCode()
      9-Digit ABA RTN (Routing Number) or BIC
      Returns:
      bankCode

    • setBankCode

      public void setBankCode(@Nonnull String bankCode)

    • bankCodeType

      public CreateBankRequest bankCodeType(@Nonnull CreateBankRequest.BankCodeTypeEnum bankCodeType)

    • getBankCodeType

      @Nonnull public CreateBankRequest.BankCodeTypeEnum getBankCodeType()
      ABA (Domestic) or BIC (International)
      Returns:
      bankCodeType

    • setBankCodeType

      public void setBankCodeType(@Nonnull CreateBankRequest.BankCodeTypeEnum bankCodeType)

    • city

      public CreateBankRequest city(@Nullable String city)

    • getCity

      @Nullable public String getCity()
      Only for international banks, ie if bank_code_type = BIC
      Returns:
      city

    • setCity

      public void setCity(@Nullable String city)

    • country

      public CreateBankRequest country(@Nullable String country)

    • getCountry

      @Nullable public String getCountry()
      Only for international banks, ie if bank_code_type = BIC
      Returns:
      country

    • setCountry

      public void setCountry(@Nullable String country)

    • extraFields

      public CreateBankRequest extraFields(@Nullable BankAdditionalFields extraFields)

    • getExtraFields

      @Nullable public BankAdditionalFields getExtraFields()
      Get extraFields
      Returns:
      extraFields

    • setExtraFields

      public void setExtraFields(@Nullable BankAdditionalFields extraFields)

    • name

      public CreateBankRequest name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Name of recipient bank
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • postalCode

      public CreateBankRequest postalCode(@Nullable String postalCode)

    • getPostalCode

      @Nullable public String getPostalCode()
      Only for international banks, ie if bank_code_type = BIC. Minimum of 3 characters
      Returns:
      postalCode

    • setPostalCode

      public void setPostalCode(@Nullable String postalCode)

    • stateProvince

      public CreateBankRequest stateProvince(@Nullable String stateProvince)

    • getStateProvince

      @Nullable public String getStateProvince()
      Only for international banks, ie if bank_code_type = BIC
      Returns:
      stateProvince

    • setStateProvince

      public void setStateProvince(@Nullable String stateProvince)

    • streetAddress

      public CreateBankRequest streetAddress(@Nullable String streetAddress)

    • getStreetAddress

      @Nullable public String getStreetAddress()
      Only for international banks, ie if bank_code_type = BIC
      Returns:
      streetAddress

    • setStreetAddress

      public void setStreetAddress(@Nullable String streetAddress)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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