Package com.adyen.model.payment

Class AdditionalDataLodging

  • public class AdditionalDataLodging
extends Object
    AdditionalDataLodging

    • Field Detail

      • JSON_PROPERTY_LODGING_SPECIAL_PROGRAM_CODE

        public static final String JSON_PROPERTY_LODGING_SPECIAL_PROGRAM_CODE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_CHECK_OUT_DATE

        public static final String JSON_PROPERTY_LODGING_CHECK_OUT_DATE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_CUSTOMER_SERVICE_TOLL_FREE_NUMBER

        public static final String JSON_PROPERTY_LODGING_CUSTOMER_SERVICE_TOLL_FREE_NUMBER
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_FIRE_SAFETY_ACT_INDICATOR

        public static final String JSON_PROPERTY_LODGING_FIRE_SAFETY_ACT_INDICATOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_FOLIO_CASH_ADVANCES

        public static final String JSON_PROPERTY_LODGING_FOLIO_CASH_ADVANCES
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_FOOD_BEVERAGE_CHARGES

        public static final String JSON_PROPERTY_LODGING_FOOD_BEVERAGE_CHARGES
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_NO_SHOW_INDICATOR

        public static final String JSON_PROPERTY_LODGING_NO_SHOW_INDICATOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_PREPAID_EXPENSES

        public static final String JSON_PROPERTY_LODGING_PREPAID_EXPENSES
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_PROPERTY_PHONE_NUMBER

        public static final String JSON_PROPERTY_LODGING_PROPERTY_PHONE_NUMBER
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_ROOM1_NUMBER_OF_NIGHTS

        public static final String JSON_PROPERTY_LODGING_ROOM1_NUMBER_OF_NIGHTS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LODGING_TOTAL_ROOM_TAX

        public static final String JSON_PROPERTY_LODGING_TOTAL_ROOM_TAX
        See Also:
        Constant Field Values

      • JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_DURATION

        public static final String JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_DURATION
        See Also:
        Constant Field Values

      • JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_MARKET

        public static final String JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_MARKET
        See Also:
        Constant Field Values

    • Constructor Detail

      • AdditionalDataLodging

        public AdditionalDataLodging()

    • Method Detail

      • lodgingSpecialProgramCode

        public AdditionalDataLodging lodgingSpecialProgramCode​(String lodgingSpecialProgramCode)
        A code that corresponds to the category of lodging charges for the payment. Possible values: * 1: Lodging * 2: No show reservation * 3: Advanced deposit
        Parameters:
        lodgingSpecialProgramCode -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingSpecialProgramCode

        public String getLodgingSpecialProgramCode()
        A code that corresponds to the category of lodging charges for the payment. Possible values: * 1: Lodging * 2: No show reservation * 3: Advanced deposit
        Returns:
        lodgingSpecialProgramCode

      • setLodgingSpecialProgramCode

        public void setLodgingSpecialProgramCode​(String lodgingSpecialProgramCode)
        A code that corresponds to the category of lodging charges for the payment. Possible values: * 1: Lodging * 2: No show reservation * 3: Advanced deposit
        Parameters:
        lodgingSpecialProgramCode -

      • lodgingCheckInDate

        public AdditionalDataLodging lodgingCheckInDate​(String lodgingCheckInDate)
        The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
        Parameters:
        lodgingCheckInDate -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingCheckInDate

        public String getLodgingCheckInDate()
        The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
        Returns:
        lodgingCheckInDate

      • setLodgingCheckInDate

        public void setLodgingCheckInDate​(String lodgingCheckInDate)
        The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
        Parameters:
        lodgingCheckInDate -

      • lodgingCheckOutDate

        public AdditionalDataLodging lodgingCheckOutDate​(String lodgingCheckOutDate)
        The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
        Parameters:
        lodgingCheckOutDate -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingCheckOutDate

        public String getLodgingCheckOutDate()
        The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
        Returns:
        lodgingCheckOutDate

      • setLodgingCheckOutDate

        public void setLodgingCheckOutDate​(String lodgingCheckOutDate)
        The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.
        Parameters:
        lodgingCheckOutDate -

      • lodgingCustomerServiceTollFreeNumber

        public AdditionalDataLodging lodgingCustomerServiceTollFreeNumber​(String lodgingCustomerServiceTollFreeNumber)
        The toll-free phone number for the lodging. * Format: numeric * Max length: 17 characters. * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - * Must not be all zeros.
        Parameters:
        lodgingCustomerServiceTollFreeNumber -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingCustomerServiceTollFreeNumber

        public String getLodgingCustomerServiceTollFreeNumber()
        The toll-free phone number for the lodging. * Format: numeric * Max length: 17 characters. * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - * Must not be all zeros.
        Returns:
        lodgingCustomerServiceTollFreeNumber

      • setLodgingCustomerServiceTollFreeNumber

        public void setLodgingCustomerServiceTollFreeNumber​(String lodgingCustomerServiceTollFreeNumber)
        The toll-free phone number for the lodging. * Format: numeric * Max length: 17 characters. * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - * Must not be all zeros.
        Parameters:
        lodgingCustomerServiceTollFreeNumber -

      • lodgingFireSafetyActIndicator

        public AdditionalDataLodging lodgingFireSafetyActIndicator​(String lodgingFireSafetyActIndicator)
        Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be 'Y' or 'N'. * Format: alphabetic * Max length: 1 character
        Parameters:
        lodgingFireSafetyActIndicator -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingFireSafetyActIndicator

        public String getLodgingFireSafetyActIndicator()
        Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be 'Y' or 'N'. * Format: alphabetic * Max length: 1 character
        Returns:
        lodgingFireSafetyActIndicator

      • setLodgingFireSafetyActIndicator

        public void setLodgingFireSafetyActIndicator​(String lodgingFireSafetyActIndicator)
        Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be 'Y' or 'N'. * Format: alphabetic * Max length: 1 character
        Parameters:
        lodgingFireSafetyActIndicator -

      • lodgingFolioCashAdvances

        public AdditionalDataLodging lodgingFolioCashAdvances​(String lodgingFolioCashAdvances)
        The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters
        Parameters:
        lodgingFolioCashAdvances -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingFolioCashAdvances

        public String getLodgingFolioCashAdvances()
        The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters
        Returns:
        lodgingFolioCashAdvances

      • setLodgingFolioCashAdvances

        public void setLodgingFolioCashAdvances​(String lodgingFolioCashAdvances)
        The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters
        Parameters:
        lodgingFolioCashAdvances -

      • lodgingFolioNumber

        public AdditionalDataLodging lodgingFolioNumber​(String lodgingFolioNumber)
        The card acceptor’s internal invoice or billing ID reference number. * Max length: 25 characters * Must not start with a space * Must not contain any special characters * Must not be all zeros.
        Parameters:
        lodgingFolioNumber -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingFolioNumber

        public String getLodgingFolioNumber()
        The card acceptor’s internal invoice or billing ID reference number. * Max length: 25 characters * Must not start with a space * Must not contain any special characters * Must not be all zeros.
        Returns:
        lodgingFolioNumber

      • setLodgingFolioNumber

        public void setLodgingFolioNumber​(String lodgingFolioNumber)
        The card acceptor’s internal invoice or billing ID reference number. * Max length: 25 characters * Must not start with a space * Must not contain any special characters * Must not be all zeros.
        Parameters:
        lodgingFolioNumber -

      • lodgingFoodBeverageCharges

        public AdditionalDataLodging lodgingFoodBeverageCharges​(String lodgingFoodBeverageCharges)
        Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters
        Parameters:
        lodgingFoodBeverageCharges -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingFoodBeverageCharges

        public String getLodgingFoodBeverageCharges()
        Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters
        Returns:
        lodgingFoodBeverageCharges

      • setLodgingFoodBeverageCharges

        public void setLodgingFoodBeverageCharges​(String lodgingFoodBeverageCharges)
        Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters
        Parameters:
        lodgingFoodBeverageCharges -

      • lodgingNoShowIndicator

        public AdditionalDataLodging lodgingNoShowIndicator​(String lodgingNoShowIndicator)
        Indicates if the customer didn't check in for their booking. Possible values: * **Y**: the customer didn't check in * **N**: the customer checked in
        Parameters:
        lodgingNoShowIndicator -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingNoShowIndicator

        public String getLodgingNoShowIndicator()
        Indicates if the customer didn't check in for their booking. Possible values: * **Y**: the customer didn't check in * **N**: the customer checked in
        Returns:
        lodgingNoShowIndicator

      • setLodgingNoShowIndicator

        public void setLodgingNoShowIndicator​(String lodgingNoShowIndicator)
        Indicates if the customer didn't check in for their booking. Possible values: * **Y**: the customer didn't check in * **N**: the customer checked in
        Parameters:
        lodgingNoShowIndicator -

      • lodgingPrepaidExpenses

        public AdditionalDataLodging lodgingPrepaidExpenses​(String lodgingPrepaidExpenses)
        The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters
        Parameters:
        lodgingPrepaidExpenses -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingPrepaidExpenses

        public String getLodgingPrepaidExpenses()
        The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters
        Returns:
        lodgingPrepaidExpenses

      • setLodgingPrepaidExpenses

        public void setLodgingPrepaidExpenses​(String lodgingPrepaidExpenses)
        The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters
        Parameters:
        lodgingPrepaidExpenses -

      • lodgingPropertyPhoneNumber

        public AdditionalDataLodging lodgingPropertyPhoneNumber​(String lodgingPropertyPhoneNumber)
        The lodging property location's phone number. * Format: numeric * Min length: 10 characters * Max length: 17 characters * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - * Must not be all zeros.
        Parameters:
        lodgingPropertyPhoneNumber -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingPropertyPhoneNumber

        public String getLodgingPropertyPhoneNumber()
        The lodging property location's phone number. * Format: numeric * Min length: 10 characters * Max length: 17 characters * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - * Must not be all zeros.
        Returns:
        lodgingPropertyPhoneNumber

      • setLodgingPropertyPhoneNumber

        public void setLodgingPropertyPhoneNumber​(String lodgingPropertyPhoneNumber)
        The lodging property location's phone number. * Format: numeric * Min length: 10 characters * Max length: 17 characters * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - * Must not be all zeros.
        Parameters:
        lodgingPropertyPhoneNumber -

      • lodgingRoom1NumberOfNights

        public AdditionalDataLodging lodgingRoom1NumberOfNights​(String lodgingRoom1NumberOfNights)
        The total number of nights the room is booked for. * Format: numeric * Must be a number between 0 and 99 * Max length: 4 characters
        Parameters:
        lodgingRoom1NumberOfNights -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingRoom1NumberOfNights

        public String getLodgingRoom1NumberOfNights()
        The total number of nights the room is booked for. * Format: numeric * Must be a number between 0 and 99 * Max length: 4 characters
        Returns:
        lodgingRoom1NumberOfNights

      • setLodgingRoom1NumberOfNights

        public void setLodgingRoom1NumberOfNights​(String lodgingRoom1NumberOfNights)
        The total number of nights the room is booked for. * Format: numeric * Must be a number between 0 and 99 * Max length: 4 characters
        Parameters:
        lodgingRoom1NumberOfNights -

      • lodgingRoom1Rate

        public AdditionalDataLodging lodgingRoom1Rate​(String lodgingRoom1Rate)
        The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Parameters:
        lodgingRoom1Rate -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingRoom1Rate

        public String getLodgingRoom1Rate()
        The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Returns:
        lodgingRoom1Rate

      • setLodgingRoom1Rate

        public void setLodgingRoom1Rate​(String lodgingRoom1Rate)
        The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Parameters:
        lodgingRoom1Rate -

      • lodgingTotalRoomTax

        public AdditionalDataLodging lodgingTotalRoomTax​(String lodgingTotalRoomTax)
        The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Parameters:
        lodgingTotalRoomTax -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingTotalRoomTax

        public String getLodgingTotalRoomTax()
        The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Returns:
        lodgingTotalRoomTax

      • setLodgingTotalRoomTax

        public void setLodgingTotalRoomTax​(String lodgingTotalRoomTax)
        The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Parameters:
        lodgingTotalRoomTax -

      • lodgingTotalTax

        public AdditionalDataLodging lodgingTotalTax​(String lodgingTotalTax)
        The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Parameters:
        lodgingTotalTax -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getLodgingTotalTax

        public String getLodgingTotalTax()
        The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Returns:
        lodgingTotalTax

      • setLodgingTotalTax

        public void setLodgingTotalTax​(String lodgingTotalTax)
        The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number
        Parameters:
        lodgingTotalTax -

      • travelEntertainmentAuthDataDuration

        public AdditionalDataLodging travelEntertainmentAuthDataDuration​(String travelEntertainmentAuthDataDuration)
        The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters
        Parameters:
        travelEntertainmentAuthDataDuration -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getTravelEntertainmentAuthDataDuration

        public String getTravelEntertainmentAuthDataDuration()
        The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters
        Returns:
        travelEntertainmentAuthDataDuration

      • setTravelEntertainmentAuthDataDuration

        public void setTravelEntertainmentAuthDataDuration​(String travelEntertainmentAuthDataDuration)
        The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters
        Parameters:
        travelEntertainmentAuthDataDuration -

      • travelEntertainmentAuthDataMarket

        public AdditionalDataLodging travelEntertainmentAuthDataMarket​(String travelEntertainmentAuthDataMarket)
        Indicates what market-specific dataset will be submitted. Must be 'H' for Hotel. This should be included in the auth message. * Format: alphanumeric * Max length: 1 character
        Parameters:
        travelEntertainmentAuthDataMarket -
        Returns:
        the current AdditionalDataLodging instance, allowing for method chaining

      • getTravelEntertainmentAuthDataMarket

        public String getTravelEntertainmentAuthDataMarket()
        Indicates what market-specific dataset will be submitted. Must be 'H' for Hotel. This should be included in the auth message. * Format: alphanumeric * Max length: 1 character
        Returns:
        travelEntertainmentAuthDataMarket

      • setTravelEntertainmentAuthDataMarket

        public void setTravelEntertainmentAuthDataMarket​(String travelEntertainmentAuthDataMarket)
        Indicates what market-specific dataset will be submitted. Must be 'H' for Hotel. This should be included in the auth message. * Format: alphanumeric * Max length: 1 character
        Parameters:
        travelEntertainmentAuthDataMarket -

      • equals

        public boolean equals​(Object o)
        Return true if this AdditionalDataLodging object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static AdditionalDataLodging fromJson​(String jsonString)
                                      throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of AdditionalDataLodging given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of AdditionalDataLodging
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to AdditionalDataLodging

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of AdditionalDataLodging to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException