Cancel

POST

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

The cancel endpoint allows the reservation to be cancelled.

Request

{
    "reservationId": "ETSR111111111",
    "roomConfirmationCodes": [
        "123"
    ],
    "reason": "cancel reason"
}

Response

{
  "cancelInfos": [
    {
      "price": 1000.0,
      "refundPrice": 1000.0,
      "currency": "TRY",
      "roomCode": "10882494",
      "success": true
    }
  ],
  "cancelationPolicies": [
    {
      "amount": 0.0,
      "currency": "EUR",
      "toDate": "2023-09-05T12:00:00",
      "fromDate": "2023-07-13T12:10:47.956938"
    },
    {
      "amount": 500.0,
      "currency": "EUR",
      "toDate": "2023-09-10T12:00:00",
      "fromDate": "2023-09-05T12:00:00"
    },
    {
      "amount": 1000.0,
      "currency": "EUR",
      "toDate": "2023-09-15T12:00:00",
      "fromDate": "2023-09-10T12:00:00"
    }
  ],
  "cancelRateInfo": {
    "fromCurrencyCode": "EUR",
    "toCurrencyCode": "TRY",
    "rate": 20.359
  },
  "cancelId": "Cncl17193498"
}

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