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

Class TravelRuleInfo

java.lang.Object
markets.alpaca.client.openapi.broker.model.TravelRuleInfo
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.25.0") public class TravelRuleInfo extends Object implements Serializable
Travel rule information pertaining to the wallet being whitelisted. Identify the destination by providing beneficiary_vasp_id, setting beneficiary_is_self_hosted to true, or providing beneficiary_manual_entry. Either beneficiary_entity_name (for legal entities) or beneficiary_given_name and beneficiary_family_name (for natural persons) must be provided.
See Also:

  • Field Details

    • SERIALIZED_NAME_BENEFICIARY_COUNTRY_OF_RESIDENCE

      public static final String SERIALIZED_NAME_BENEFICIARY_COUNTRY_OF_RESIDENCE
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_ENTITY_NAME

      public static final String SERIALIZED_NAME_BENEFICIARY_ENTITY_NAME
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_FAMILY_NAME

      public static final String SERIALIZED_NAME_BENEFICIARY_FAMILY_NAME
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_BUILDING_NUMBER

      public static final String SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_BUILDING_NUMBER
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_COUNTRY

      public static final String SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_COUNTRY
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_POST_CODE

      public static final String SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_POST_CODE
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_STREET_NAME

      public static final String SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_STREET_NAME
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_TOWN_NAME

      public static final String SERIALIZED_NAME_BENEFICIARY_GEOGRAPHIC_ADDRESS_TOWN_NAME
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_GIVEN_NAME

      public static final String SERIALIZED_NAME_BENEFICIARY_GIVEN_NAME
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_IS_SELF_HOSTED

      public static final String SERIALIZED_NAME_BENEFICIARY_IS_SELF_HOSTED
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_MANUAL_ENTRY

      public static final String SERIALIZED_NAME_BENEFICIARY_MANUAL_ENTRY
      See Also:

    • SERIALIZED_NAME_BENEFICIARY_VASP_ID

      public static final String SERIALIZED_NAME_BENEFICIARY_VASP_ID
      See Also:

    • openapiFields

      public static HashSet<String> openapiFields

    • openapiRequiredFields

      public static HashSet<String> openapiRequiredFields

  • Constructor Details

    • TravelRuleInfo

      public TravelRuleInfo()

  • Method Details

    • beneficiaryCountryOfResidence

      public TravelRuleInfo beneficiaryCountryOfResidence(@Nullable String beneficiaryCountryOfResidence)

    • getBeneficiaryCountryOfResidence

      @Nullable public String getBeneficiaryCountryOfResidence()
      ISO 3166-1 country code for the beneficiary's country of residence.
      Returns:
      beneficiaryCountryOfResidence

    • setBeneficiaryCountryOfResidence

      public void setBeneficiaryCountryOfResidence(@Nullable String beneficiaryCountryOfResidence)

    • beneficiaryEntityName

      public TravelRuleInfo beneficiaryEntityName(@Nullable String beneficiaryEntityName)

    • getBeneficiaryEntityName

      @Nullable public String getBeneficiaryEntityName()
      The beneficiary's legal entity name (required for legal entities)
      Returns:
      beneficiaryEntityName

    • setBeneficiaryEntityName

      public void setBeneficiaryEntityName(@Nullable String beneficiaryEntityName)

    • beneficiaryFamilyName

      public TravelRuleInfo beneficiaryFamilyName(@Nullable String beneficiaryFamilyName)

    • getBeneficiaryFamilyName

      @Nullable public String getBeneficiaryFamilyName()
      The beneficiary's last name (required for natural persons)
      Returns:
      beneficiaryFamilyName

    • setBeneficiaryFamilyName

      public void setBeneficiaryFamilyName(@Nullable String beneficiaryFamilyName)

    • beneficiaryGeographicAddressBuildingNumber

      public TravelRuleInfo beneficiaryGeographicAddressBuildingNumber(@Nullable String beneficiaryGeographicAddressBuildingNumber)

    • getBeneficiaryGeographicAddressBuildingNumber

      @Nullable public String getBeneficiaryGeographicAddressBuildingNumber()
      Building number in the beneficiary's geographic address.
      Returns:
      beneficiaryGeographicAddressBuildingNumber

    • setBeneficiaryGeographicAddressBuildingNumber

      public void setBeneficiaryGeographicAddressBuildingNumber(@Nullable String beneficiaryGeographicAddressBuildingNumber)

    • beneficiaryGeographicAddressCountry

      public TravelRuleInfo beneficiaryGeographicAddressCountry(@Nullable String beneficiaryGeographicAddressCountry)

    • getBeneficiaryGeographicAddressCountry

      @Nullable public String getBeneficiaryGeographicAddressCountry()
      ISO 3166-1 alpha-2 or alpha-3 country code in the beneficiary's geographic address.
      Returns:
      beneficiaryGeographicAddressCountry

    • setBeneficiaryGeographicAddressCountry

      public void setBeneficiaryGeographicAddressCountry(@Nullable String beneficiaryGeographicAddressCountry)

    • beneficiaryGeographicAddressPostCode

      public TravelRuleInfo beneficiaryGeographicAddressPostCode(@Nullable String beneficiaryGeographicAddressPostCode)

    • getBeneficiaryGeographicAddressPostCode

      @Nullable public String getBeneficiaryGeographicAddressPostCode()
      Postal code in the beneficiary's geographic address.
      Returns:
      beneficiaryGeographicAddressPostCode

    • setBeneficiaryGeographicAddressPostCode

      public void setBeneficiaryGeographicAddressPostCode(@Nullable String beneficiaryGeographicAddressPostCode)

    • beneficiaryGeographicAddressStreetName

      public TravelRuleInfo beneficiaryGeographicAddressStreetName(@Nullable String beneficiaryGeographicAddressStreetName)

    • getBeneficiaryGeographicAddressStreetName

      @Nullable public String getBeneficiaryGeographicAddressStreetName()
      Street name in the beneficiary's geographic address.
      Returns:
      beneficiaryGeographicAddressStreetName

    • setBeneficiaryGeographicAddressStreetName

      public void setBeneficiaryGeographicAddressStreetName(@Nullable String beneficiaryGeographicAddressStreetName)

    • beneficiaryGeographicAddressTownName

      public TravelRuleInfo beneficiaryGeographicAddressTownName(@Nullable String beneficiaryGeographicAddressTownName)

    • getBeneficiaryGeographicAddressTownName

      @Nullable public String getBeneficiaryGeographicAddressTownName()
      Town or city in the beneficiary's geographic address.
      Returns:
      beneficiaryGeographicAddressTownName

    • setBeneficiaryGeographicAddressTownName

      public void setBeneficiaryGeographicAddressTownName(@Nullable String beneficiaryGeographicAddressTownName)

    • beneficiaryGivenName

      public TravelRuleInfo beneficiaryGivenName(@Nullable String beneficiaryGivenName)

    • getBeneficiaryGivenName

      @Nullable public String getBeneficiaryGivenName()
      The beneficiary's first name (required for natural persons)
      Returns:
      beneficiaryGivenName

    • setBeneficiaryGivenName

      public void setBeneficiaryGivenName(@Nullable String beneficiaryGivenName)

    • beneficiaryIsSelfHosted

      public TravelRuleInfo beneficiaryIsSelfHosted(@Nullable Boolean beneficiaryIsSelfHosted)

    • getBeneficiaryIsSelfHosted

      @Nullable public Boolean getBeneficiaryIsSelfHosted()
      Beneficiary is receiving funds to a self-hosted / non-custodial wallet
      Returns:
      beneficiaryIsSelfHosted

    • setBeneficiaryIsSelfHosted

      public void setBeneficiaryIsSelfHosted(@Nullable Boolean beneficiaryIsSelfHosted)

    • beneficiaryManualEntry

      public TravelRuleInfo beneficiaryManualEntry(@Nullable TravelRuleManualEntry beneficiaryManualEntry)

    • getBeneficiaryManualEntry

      @Nullable public TravelRuleManualEntry getBeneficiaryManualEntry()
      Get beneficiaryManualEntry
      Returns:
      beneficiaryManualEntry

    • setBeneficiaryManualEntry

      public void setBeneficiaryManualEntry(@Nullable TravelRuleManualEntry beneficiaryManualEntry)

    • beneficiaryVaspId

      public TravelRuleInfo beneficiaryVaspId(@Nullable String beneficiaryVaspId)

    • getBeneficiaryVaspId

      @Nullable public String getBeneficiaryVaspId()
      The W3C Decentralized Identifier (DID) representing the beneficiary's VASP.
      Returns:
      beneficiaryVaspId

    • setBeneficiaryVaspId

      public void setBeneficiaryVaspId(@Nullable String beneficiaryVaspId)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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