Cancel a booking
POST/v1/transfer/cancel
Cancels a booking. Some providers answer cancellation_pending first; poll booking-details until booking.status is cancelled. Only bookings made with your account can be cancelled (404 otherwise); a modified supplier_reference answers 422 invalid_booking_token. A booking TransferPlatform already cancelled is answered from its records (Idempotent-Replayed: true) without calling the provider again; a provider that did not answer in time gives status: unknown (check booking-details).
Guide: Cancellations & refunds.
Request
Responses
- 200
- 401
- 403
- 404
- 413
- 422
- 429
- 500
- 503
OK
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Present when the response is the stored result of an earlier identical request (no new provider call).
Missing or invalid API key (unauthorized). Header WWW-Authenticate: ApiKey header="X-API-Key".
Response Headers
ApiKey header="X-API-Key"
Provider not enabled for this API key (provider_not_enabled).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Booking not found for your account (booking_not_found).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Request body larger than 256 KB (payload_too_large).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Invalid request body (validation_error), or a missing / modified / foreign token (invalid_booking_token).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Rate limit exceeded for this API key (rate_limited). Wait Retry-After seconds.
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Seconds to wait before retrying.
Unexpected error (internal_error); no details are returned. Report it with the request_id.
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Authentication or booking records temporarily unavailable (auth_unavailable, service_unavailable). Nothing reached a provider. Retry with backoff.
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.