Class Address

    • Method Detail

      • addressLine1

        public final String addressLine1()

        The first line of the address.

        Returns:
        The first line of the address.
      • addressLine2

        public final String addressLine2()

        The second line of the address, if applicable.

        Returns:
        The second line of the address, if applicable.
      • addressLine3

        public final String addressLine3()

        The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234.

        Returns:
        The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234.
      • city

        public final String city()

        The city that the address is in.

        Returns:
        The city that the address is in.
      • countryCode

        public final String countryCode()

        The country code for the country that the address is in.

        Returns:
        The country code for the country that the address is in.
      • districtOrCounty

        public final String districtOrCounty()

        The district or county the address is located.

        For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name.

        Returns:
        The district or county the address is located.

        For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name.

      • postalCode

        public final String postalCode()

        The postal code associated with the address.

        Returns:
        The postal code associated with the address.
      • stateOrRegion

        public final String stateOrRegion()

        The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.

        If this is required for tax settings, use the same name as shown on the Tax Settings page.

        Returns:
        The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.

        If this is required for tax settings, use the same name as shown on the Tax Settings page.

      • serializableBuilderClass

        public static Class<? extends Address.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)