Cancel journey
POST
/journeys/{journeyId}/cancelAuth: X-API-Key headerhttps://warpdrive.staging.transferz.com/partners
Cancels a previously created journey
Cancels one journey of a booking, for example only the return leg. Same rules as Cancel booking: free inside the window, otherwise send acceptCharges true.
Guides: How a booking works, Cancel a journey or a booking, Constants
Path parameters
Headers
Request body
application/json · required
Why the journey 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
Current status of the journey.
NOT_PAID- The booking exists but has not been paid; the journey is not yet sent to a transfer company.
AWAITING_APPROVAL- Paid, waiting for an internal Transferz approval before it is processed.
PENDING- Paid and being processed; Transferz is looking for a transfer company.
CONFIRMED- A transfer company has been assigned and confirmed the journey.
PLANNED- A driver has been assigned.
DRIVER_UNDERWAY- The driver is on the way to the pickup point.
Errors this endpoint can return
- 400, failedCANCELLATION_NOT_ALLOWED_FOR_JOURNEY
When: Outside the free window with acceptCharges false, or the journey is completed or already cancelled.
What to do: Send acceptCharges true to cancel with costs, after confirming the traveller accepts them. Completed or cancelled journeys cannot be cancelled.