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

Class TransmitterInfo

java.lang.Object
markets.alpaca.client.openapi.broker.model.TransmitterInfo
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class TransmitterInfo extends Object implements Serializable
Information about the transmitter to satisfy travel rule requirements. Required if the requesting correspondent qualifies as a financial institution
See Also:

  • Field Details

    • SERIALIZED_NAME_ORIGINATOR_BANK_ACCOUNT_NUMBER

      public static final String SERIALIZED_NAME_ORIGINATOR_BANK_ACCOUNT_NUMBER
      See Also:

    • SERIALIZED_NAME_ORIGINATOR_BANK_NAME

      public static final String SERIALIZED_NAME_ORIGINATOR_BANK_NAME
      See Also:

    • SERIALIZED_NAME_ORIGINATOR_CITY

      public static final String SERIALIZED_NAME_ORIGINATOR_CITY
      See Also:

    • SERIALIZED_NAME_ORIGINATOR_COUNTRY

      public static final String SERIALIZED_NAME_ORIGINATOR_COUNTRY
      See Also:

    • SERIALIZED_NAME_ORIGINATOR_FULL_NAME

      public static final String SERIALIZED_NAME_ORIGINATOR_FULL_NAME
      See Also:

    • SERIALIZED_NAME_ORIGINATOR_POSTAL_CODE

      public static final String SERIALIZED_NAME_ORIGINATOR_POSTAL_CODE
      See Also:

    • SERIALIZED_NAME_ORIGINATOR_STATE

      public static final String SERIALIZED_NAME_ORIGINATOR_STATE
      See Also:

    • SERIALIZED_NAME_ORIGINATOR_STREET_ADDRESS

      public static final String SERIALIZED_NAME_ORIGINATOR_STREET_ADDRESS
      See Also:

    • SERIALIZED_NAME_OTHER_IDENTIFYING_INFORMATION

      public static final String SERIALIZED_NAME_OTHER_IDENTIFYING_INFORMATION
      See Also:

    • openapiFields

      public static HashSet<String> openapiFields

    • openapiRequiredFields

      public static HashSet<String> openapiRequiredFields

  • Constructor Details

    • TransmitterInfo

      public TransmitterInfo()

  • Method Details

    • originatorBankAccountNumber

      public TransmitterInfo originatorBankAccountNumber(@Nullable String originatorBankAccountNumber)

    • getOriginatorBankAccountNumber

      @Nullable public String getOriginatorBankAccountNumber()
      Required if the requesting correspondent qualifies as a financial institution
      Returns:
      originatorBankAccountNumber

    • setOriginatorBankAccountNumber

      public void setOriginatorBankAccountNumber(@Nullable String originatorBankAccountNumber)

    • originatorBankName

      public TransmitterInfo originatorBankName(@Nullable String originatorBankName)

    • getOriginatorBankName

      @Nullable public String getOriginatorBankName()
      Required if the requesting correspondent qualifies as a financial institution
      Returns:
      originatorBankName

    • setOriginatorBankName

      public void setOriginatorBankName(@Nullable String originatorBankName)

    • originatorCity

      public TransmitterInfo originatorCity(@Nullable String originatorCity)

    • getOriginatorCity

      @Nullable public String getOriginatorCity()
      Get originatorCity
      Returns:
      originatorCity

    • setOriginatorCity

      public void setOriginatorCity(@Nullable String originatorCity)

    • originatorCountry

      public TransmitterInfo originatorCountry(@Nullable String originatorCountry)

    • getOriginatorCountry

      @Nullable public String getOriginatorCountry()
      Required if the requesting correspondent qualifies as a financial institution
      Returns:
      originatorCountry

    • setOriginatorCountry

      public void setOriginatorCountry(@Nullable String originatorCountry)

    • originatorFullName

      public TransmitterInfo originatorFullName(@Nullable String originatorFullName)

    • getOriginatorFullName

      @Nullable public String getOriginatorFullName()
      Required if the requesting correspondent qualifies as a financial institution
      Returns:
      originatorFullName

    • setOriginatorFullName

      public void setOriginatorFullName(@Nullable String originatorFullName)

    • originatorPostalCode

      public TransmitterInfo originatorPostalCode(@Nullable String originatorPostalCode)

    • getOriginatorPostalCode

      @Nullable public String getOriginatorPostalCode()
      Get originatorPostalCode
      Returns:
      originatorPostalCode

    • setOriginatorPostalCode

      public void setOriginatorPostalCode(@Nullable String originatorPostalCode)

    • originatorState

      public TransmitterInfo originatorState(@Nullable String originatorState)

    • getOriginatorState

      @Nullable public String getOriginatorState()
      Get originatorState
      Returns:
      originatorState

    • setOriginatorState

      public void setOriginatorState(@Nullable String originatorState)

    • originatorStreetAddress

      public TransmitterInfo originatorStreetAddress(@Nullable String originatorStreetAddress)

    • getOriginatorStreetAddress

      @Nullable public String getOriginatorStreetAddress()
      Get originatorStreetAddress
      Returns:
      originatorStreetAddress

    • setOriginatorStreetAddress

      public void setOriginatorStreetAddress(@Nullable String originatorStreetAddress)

    • otherIdentifyingInformation

      public TransmitterInfo otherIdentifyingInformation(@Nullable String otherIdentifyingInformation)

    • getOtherIdentifyingInformation

      @Nullable public String getOtherIdentifyingInformation()
      Used to facilitate transfer lookup in the event it is required. Recommended to be the originating bank's reference number for the transfer
      Returns:
      otherIdentifyingInformation

    • setOtherIdentifyingInformation

      public void setOtherIdentifyingInformation(@Nullable String otherIdentifyingInformation)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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