Cancel a reservation

Cancels an existing reservation, with options to init or commit the cancellation and specify cancellation details. This API supports two cancellation workflows for flexible operation:

Two-step cancellation (recommended for penalty confirmation)

  1. Step 1: Init
    Send an init request to retrieve the applicable cancellation penalty (e.g., fee amount, percentage of total price) without actually cancelling the reservation.

  2. Step 2: Commit
    Submit a commit request with the correct penalty value obtained from the init step to finalize the cancellation. The request will be rejected if the penalty value does not match the calculated amount.

One-step cancellation (for direct, confirmed operations)

Skip the init step and directly send a commit request to complete cancellation in one call. Ensure the request carries the accurate pre-calculated penalty value; otherwise, the cancellation will fail.

Typical Use Cases

  • User-Facing Systems: Use the two-step workflow. First display the penalty to the user for confirmation, then submit the cancellation after the user agrees.
  • Backend Integration: Use the one-step workflow if the integrated system can calculate the penalty based on the cancel policy
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the hotel

string
required

Unique identifier of the reservation to cancel

Body Params
string
required

Action to perform (Init, Commit)

string
required

Type of cancellation (All, Rooms)

cancelRooms
array of objects

List of room reservations to cancel (if type is Rooms)

cancelRooms
penalty
object

Penalty information for cancellation

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json