Cancel booking
/bookings/{id}/cancelAuth: X-API-Key headerhttps://warpdrive.staging.transferz.com/partners
Cancels the journeys in a previously created booking
Cancels every journey in the booking that can still be cancelled and returns the updated booking. Journeys that can no longer be cancelled (for example completed ones) are left as they are; check each journey's status in the response.
Inside the free cancellation window (cancellationDetails.freeCancellationUntil) the result is CANCELLED_FREE. After it, send acceptCharges true to cancel with costs; the journey then becomes CANCELLED_WITH_COSTS.
Path parameters
Headers
Request body
application/json · required
Why the booking is cancelled.
NOT_NEEDED_ANYMORE- The traveller no longer needs the transfer.
DRIVER_NO_SHOW- The driver did not show up.
NO_AVAILABILITY- No availability.
ADDRESS_INVALID- The address is wrong or cannot be served.
INSUFFICIENT_TRAVELLER_DETAILS- Traveller details are missing.
TECHNICAL_ISSUE- A technical problem.
Responses
OK
Errors this endpoint can return
- 400, failedCANCELLATION_NOT_ALLOWED_FOR_JOURNEY
When: The free cancellation window has passed and acceptCharges is false.
What to do: Confirm the costs with the traveller and send acceptCharges true.
- 400, failedNULL_VALUE
When: reason is missing.
What to do: Send the field named in
field. Required fields are marked in the reference.