Last updated

Option

Fields

FieldDescriptionTypeMin/maxNotes
Options/
Option		Additional configuration for certain types of StandardPhrase.string0..*-
Option/
@Name		The type of option.enum1..1Accepts: KeyCollectionAddressLine, KeyCollectionCityName, KeyCollectionPostalCode, RenovationFrom, RenovationUntil, SecurityDepositAmount, SecurityDepositCollectMethod, SecurityDepositCollectWhen, SecurityDepositCollectNumDays, SecurityDepositReturnMethod, SecurityDepositReturnWhen, HotelChainBedLinenAmount. See @Name for details.

@Name

Option[@Name] accepts the values in the table below.

Note

The first part of each value's name refers to a value of StandardPhrase[@Name]. This reference indicates a certain requirement, explained in the Description column.

ValueDescription
KeyCollectionAddressLineThe street name and number for the key collection address. Required if StandardPhrase[@Name="KeyCollection"].
KeyCollectionCityNameThe city name for the key collection address. Required if StandardPhrase[@Name="KeyCollection"].
KeyCollectionPostalCodeThe postal code for the key collection address. Required if StandardPhrase[@Name="KeyCollection"].
RenovationFromThe start date of the renovations. Format: YYYY-MM-DD. Required if StandardPhrase[@Name="Renovation"].
RenovationUntilThe end date of the renovations. Format: YYYY-MM-DD. Required if StandardPhrase[@Name="Renovation"].
SecurityDepositAmountThe deposit amount, in the property's default currency. Required if StandardPhrase[@Name="SecurityDeposit"]. There is a limit on maximum deposit , see security deposit limits.
SecurityDepositCollectMethodThe deposit collection method. Accepts: bank_transfer, credit_card, paypal, cash. Required if StandardPhrase[@Name="SecurityDeposit"]. Note that if the property has not been verified to use credit card payments, the default value becomes cash regardless of setting it to credit_card.
SecurityDepositCollectWhenThe moment when the property will collect the deposit. Accepts: before_arrival, upon_arrival, when_guest_books. Required if StandardPhrase[@Name="SecurityDeposit"] If value is set to when_guest_books, then this will be changed automatically to before_arrival and Option[@Name="SecurityDepositCollectNumDays"] will be set to 14.
SecurityDepositCollectNumDaysThe number of days before check-in when the property will collect the deposit. Accepts: 7, 14. Required only if StandardPhrase[@Name="SecurityDeposit"] and Option[@Name="SecurityDepositCollectWhen"] is set to before_arrival.
SecurityDepositReturnMethodThe deposit return method. Accepts: bank_transfer, credit_card, paypal, cash. Required if StandardPhrase[@Name="SecurityDeposit"].
SecurityDepositReturnWhenThe time period when the guest can expect the property to return their deposit. Accepts: on_checkout, within_7_days, within_14_days. Required if StandardPhrase[@Name="SecurityDeposit"].
HotelChainBedLinenAmountThe cost of renting bed linens and towels specified in the property's default currency. Required if StandardPhrase[@Name="HotelChainBedLinen"].

XML

<Option
  Name="KeyCollectionAddressLine">
  Rembrandtplein
</Option>
<Option
  Name="KeyCollectionCityName">
  Amsterdam
</Option>
<Option
  Name="KeyCollectionPostalCode">
  1017 CD
</Option>
...
<Option
  Name="RenovationFrom">
  2017-02-18
</Option>
<Option
  Name="RenovationUntil">
  2017-02-19
</Option>
...
<Option
  Name="SecurityDepositAmount">
  120
</Option>
...
<Option
  Name="HotelChainBedLinenAmount">
  10
</Option>

Security Deposit Limits

There are limitations on amount you can set as a security deposit (SecurityDepositAmount). The amount must be greater than 0. Other limitations vary in different cases. If you exceed the maximum allowed amount - value of your security deposit will be reset to maximum possible and you will receive a warning message like this:

   SecurityDepositAmount exceeded the limit of X, the value has been set to X.
Previous page
Next page