Skip to main content
POST
/
api
/
public
/
v2
/
bookings
/
{bookingId}
/
cancel
curl -X POST \
  "https://www.headout.com/api/public/v2/bookings/12345/cancel/" \
  --header 'Headout-Auth: <YOUR_API_KEY>' \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "CHANGE_OF_TRAVEL_PLANS",
    "comment": "Customer cannot attend"
  }'

{
  "success": true,
  "message": "<string>"
}
Submit a cancellation request for a booking owned by your partner account. This validates input and ownership, creates a request log with status SUBMITTED, and enqueues an asynchronous job for downstream processing. The immediate response acknowledges submission and does not represent the final booking outcome.

​
Refund handling

Cancellation eligibility (cancellationPolicy.cancellable, cancellableUpToInMinutes) only determines whether Headout accepts the cancellation. Refunds are handled separately:
  • When an eligible booking is cancelled, your Headout wallet is topped up automatically with the full booking amount.
  • You are responsible for refunding the end customer through your own payment system. Headout does not contact or refund the end customer.
See Cancellation & reschedule policies for details. 
curl -X POST \
  "https://www.headout.com/api/public/v2/bookings/12345/cancel/" \
  --header 'Headout-Auth: <YOUR_API_KEY>' \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "CHANGE_OF_TRAVEL_PLANS",
    "comment": "Customer cannot attend"
  }'

Authorizations

​
Headout-Auth
string
header
required

Path Parameters

​
bookingId
string
required

Booking identifier owned by the calling partner.

Body

application/json
​
reason
enum<string>
required

Cancellation reason.

Available options:
TICKETS_NOT_RECEIVED,
CHANGE_OF_TRAVEL_PLANS,
MODIFY_EXISTING_RESERVATION,
FOUND_CHEAPER_OPTION_ELSEWHERE,
OTHER
​
comment
string | null

Optional free-text comment

Response

Acknowledgement of cancellation submission or business-rule failure

​
success
boolean

Indicates whether the request was accepted

​
message
string

Human-readable message describing the outcome