Booking Notification Body
Hurray, you got a booking!
In the booking notification, you will find the following parameters:
- Required fields will always be present.
- Optional fields will only be included if applicable to the specific booking.
For partners who are migrating from HAPI V1, we've removed the
bookingIdfield. This is because, from our perspective, a true booking isn't generated until we receive successful confirmation to our booking notification request.
Parameter | Type | Required | Usage |
|---|---|---|---|
| String | Yes | The id of the apartment in your system |
| String | Yes | The provider identifier at Holidu |
| LocalDate:
| Yes | The arrival date of the guests |
| LocalDate:
| Yes | The departure date of the guests |
| Array of objects | Yes | List of guests' ages |
| Integer | Yes | Age of the guest |
| Object | Yes | Guest's personal information |
| String | Yes | Gender |
| String | Yes | First name |
| String | Yes | Last name |
| String | Yes | Street name |
| String | Yes | ZIP code |
| String | Yes | City of the guest |
| String | Yes | Country of the guest |
| String | Yes | The language that the guest speaks |
| String | Yes | Phone number of the guest |
| String | Yes | Email address of the guest |
| String | The special requests of the guest during the booking | |
| Object | Yes | Breakdown of all the amounts paid or to be paid by the guest |
| Object | Yes | Price based on LOS or rates without extra costs |
| Number | Yes | Price of the property |
| String | Yes | Currency used |
| object | Discount object as defined through the discount endpoint | |
| String | Name of the used discount | |
| Number | Percentage of the discount | |
| object | The amount discounted calculated based on the base price of the property | |
| Number | Amount | |
| String | Currency | |
| array of objects | Objects that were pushed in the extra cost endpoint and applied to the booking | |
| String | Unique id for every extra cost on your system, same as you pushed | |
| String | Name of the extra cost ( from Holidu's list ) | |
| String | Defining how the extra cost is calculated | |
| String | Payment time of the extra cost | |
| Object | The price of one unit | |
| String | Defining if the extra cost is | |
| Number | Amount | |
| String | Currency | |
| Integer | Number of units selected | |
| Object | The total price of all the units selected | |
| Number | Amount | |
| String | Currency | |
| Array | NO | |
| String | REFUNDABLE_SECURITY_DEPOSIT | |
| Object | ||
| Number | Cost of deposit | |
| String | Currency | |
| String | ONSITE | |
| Object | Yes | JSON object describing payment handling/processing |
| Object | Yes | JSON object describing payment handling of costs with the booking |
| String | Yes | The entity which is handling the payment. |
| String | Yes | Payment method used |
| Object | Only present in case of PCI integration with Holidu | |
| Object | Yes | JSON object describing the total amount which needs to be paid |
| Number | Yes | The total cost of the booking |
| String | Yes | The currency used |
| Array | Yes | JSON array describing the payment setup of the booking |
| Object | Yes | JSON object describing the amounts |
| Number | Yes | The amount which needs to be paid |
| String | Yes | The currency used |
| LocalDate:
| Yes | The due date of the payment described above |
| Array of objects | Yes | |
| Number | Total amount which needs to be paid on site | |
| String | The currency | |
| String | Yes | The name of the rate selected |
{
"providerApartmentId": "externalApartmentID",
"provider:":"XXX"
"arrival": "2022-04-29",
"departure": "2022-05-04",
"guests": [
{
"age": 25
},
{
"age": 25
},
{
"age": 25
},
{
"age": 12
},
{
"age": 8
}
],
"customer": {
"gender": "MALE",
"firstName": "First Name",
"lastName": "Last Name",
"street": "Street and number",
"zip": "Zip code",
"city": "City",
"country": "Iso country code",
"language": "Language of the customer",
"phone": "phone number of customer",
"email": "email of customer"
},
"specialCustomerRequest": "special request of the guest during booking",
"guestReceipt": {
"bareRentalPrice": {
"amount": 705.88,
"currency": "EUR"
},
"discount": {
"discountName": "LastMinute",
"discountPercent": 10,
"discountAmount": {
"amount": 70.51,
"currency": "EUR"
}
},
"costs": [
{
"id": "46323572_781803181",
"name": "CLEANING",
"basisOfCalculation": "PER_STAY",
"paymentTime": "WITH_RATES",
"type": "MANDATORY",
"pricePerUnit": {
"amount": 60.00,
"currency": "EUR"
},
"unitsSelected": 1,
"totalPrice": {
"amount": 60.00,
"currency": "EUR"
}
},
{
"id": "46323572_781803181",
"name": "PET",
"basisOfCalculation": "PER_PET",
"paymentTime": "WITH_RATES",
"type": "SELECTABLE",
"pricePerUnit": {
"amount": 20.00,
"currency": "EUR"
},
"unitsSelected": 2,
"totalPrice": {
"amount": 40.00,
"currency": "EUR"
}
},
{
"id": "46323572_781803181",
"name": "BEDLINEN",
"basisOfCalculation": "PER_UNIT",
"paymentTime": "ONSITE",
"type": "ON_USAGE",
"pricePerUnit": {
"amount": 10.00,
"currency": "EUR"
},
"unitsSelected": null,
"totalPrice": {
"amount": 0.00,
"currency": "EUR"
}
},
{
"id": "46323572_781803181",
"name": "PARKING",
"basisOfCalculation": "PER_STAY",
"paymentTime": "ONSITE",
"type": "SELECTABLE",
"pricePerUnit": {
"amount": 50.00,
"currency": "DKK"
},
"unitsSelected": 1,
"totalPrice": {
"amount": 50.00,
"currency": "DKK"
}
},
{
"id": "243234234",
"name": "TOURIST_OR_CITY_TAX",
"basisOfCalculation": "PER_STAY",
"paymentTime": "WITH_RATES",
"type": "MANDATORY",
"pricePerUnit": {
"amount": 50.00,
"currency": "EUR"
},
"unitsSelected": 1,
"totalPrice": {
"amount": 50.00,
"currency": "EUR"
}
}
],
"deposits":[
{
"name":"REFUNDABLE_SECURITY_DEPOSIT",
"price":{
"amount":700.00,
"currency":"EUR"},
"paymentTime":"ONSITE"
}
]
},
"paymentProcessing": {
"paymentWithBooking": {
"paymentHandler": "PARTNER", // HOLIDU
"paymentMethod": "CREDIT_CARD",
"creditCardData": { // only present in booking notification with PCI
},
"paymentTotalWithBooking": {
"amount": 785.37,
"currency": "EUR"
},
"paymentRates": [
{
"value": {
"amount": 628.30,
"currency": "EUR"
},
"dueDate": "2022-01-31"
},
{
"value": {
"amount": 157.07,
"currency": "EUR"
},
"dueDate": "2022-03-25"
}
]
},
"paymentOnsite": [
{
"amount": 50.00,
"currency": "DKK"
}
]
},
"rateId": "name of the rate select"
}Updated 20 days ago