Cancel

POST

/api/v1/generic-api-service/royal/hotel/book/cancel

The cancel endpoint allows the reservation to be cancelled.

cURL

curl --location 'https://test-api.etscore.com/api/v1/generic-api-service/royal/hotel/book/cancel' \
--header 'Accept-Language: en-us' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
    "reservationId": "ETSR2014683530",
    "roomConfirmationCodes": [
        "ETSR2014683530230886"
    ]
}'

Request

{
    "reservationId": "ETSR2014683530",
    "roomConfirmationCodes": [
        "ETSR2014683530230886"
    ]
}

Response

{
    "cancelInfos": [
        {
            "price": 222.13,
            "refundPrice": 222.13,
            "penaltyAmount": 0.00,
            "currency": "EUR",
            "roomCode": "230886",
            "success": true
        }
    ],
    "cancellationPolicies": [
        {
            "amount": 0,
            "currency": "EUR",
            "toDate": "2025-04-09T16:00:00",
            "fromDate": "2025-03-13T14:33:43.832628"
        },
        {
            "amount": 222.13,
            "currency": "EUR",
            "toDate": "2025-04-09T16:00:00",
            "fromDate": "2025-04-09T16:00:00"
        }
    ],
    "cancelId": "ETSR2014683530",
    "status": "CANCELLED"
}

Request Details

Name	Type	Required	Description
reservationId	string	Yes	Id of the canceled reservation.
roomConfirmationCodes	string-array	Yes	Room codes for the canceled reservation
reason	string	No	Cancel reason

Response Details

Name	Type	Required	Description
cancelInfos	object-array	Yes	Object containing the information about the cancellation of the reservation.
cancelInfos/price	decimal	Yes	Reservation price
cancelInfos/refundPrice	decimal	Yes	Price to be refunded after cancellation.
cancelInfos/currency	string	Yes	Currency in which the reservation is completed.
cancelInfos/roomCode	string	Yes	room information code
cancelInfos/success	bool	Yes	Cancellation status
cancellationPolicies	string	Yes	Object to return information for cancellation policies.
cancellationPolicies/amount	decimal	No	Penalty amount to be paid
cancellationPolicies/currency	string	No	Penalty amount currency to be paid
cancellationPolicies/toDate	string	No	Cancellation policy is valid for UTC+03:00 time zone.
cancellationPolicies/fromDate	string	No	Cancellation policy is valid for UTC+03:00 time zone.
cancelRateInfo	Object-array	Yes	Information about the currency rate to be considered during reservation cancellation.
cancelRateInfo/fromCurrencyCode	string	Yes	In which currency it will be converted.
cancelRateInfo/toCurrencyCode	string	Yes	Information on which currency to convert to.
cancelRateInfo/rate	decimal	Yes	Currency rate
cancelId	string	Yes	cancellation id