Skip to main content
POST
Use this endpoint to cancel a CONFIRMED or ON_HOLD booking. Cancellation is idempotent: a repeat request for an already cancelled or cancelling booking returns its current state rather than creating another cancellation.

Request Example

Handle Cancellation State

Keep the returned booking_id and request ID in your support record. If the request returns CANCELLATION_PENDING, do not assume the booking is cancelled until status polling reports CANCELLED or another final state.
Booking cancellation follows the supplier’s current terms. Retrieve booking details and show applicable cancellation information to the customer before they confirm the cancellation action.
The OpenAPI section below documents the required booking ID, success response, and error response.

Authorizations

x-api-key
string
header
required

Environment-specific API key created in the Unifystays portal

Headers

Path Parameters

booking_id
string
required
Example:

"ubk_eGQ0dW9uV1Vi"

Response

success
boolean
required
Example:

true

message
string
required
Example:

"Booking request accepted and is being processed."

data
object
required