Skip to content

Cancel journey

POST/journeys/{journeyId}/cancel

Auth: 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

  • journeyIdinteger · int64required

    The id of the journey to cancel

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Request body

application/json · required

  • reasonenumrequired

    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.
  • acceptChargesboolean

    Set to true to cancel after the free cancellation window, accepting the costs.

Responses

OK

  • idinteger · int64

    Journey id (journeyId in webhook events).

  • codestring

    Journey reference shown to the traveller and the driver.

  • quoteIdinteger · int64

    The quote this journey was booked from.

  • vehicleCategoryenum
    SEDAN
    Standard car for up to 3 passengers with luggage.
    STATIONWAGON
    Estate car with extra luggage space.
    SUV
    Sport utility vehicle.
    MINIVAN
    People carrier for up to 6–7 passengers.
    BUSINESS_LIMOUSINE
    Deprecated business category; use BUSINESS_SEDAN.
    BUSINESS_SEDAN
    Business-class sedan.
  • pickupTimeAdjustmentMethodenum

    Whether and how the pickup time follows the flight.

    PENDING
    Not decided yet.
    NONE
    The pickup time is not adjusted.
    FLIGHT_TRACKING
    The pickup time follows the tracked flight.
    MANUAL
    The pickup time is adjusted by hand.
  • originobject
  • destinationobject
  • pickupobject

    The pickup time.

  • transferCompanyobject

    The transfer company performing the journey, once assigned.

  • driverobject

    The driver and vehicle, once assigned.

  • meetingPointobject

    Where the driver meets the traveller.

  • approxDurationAndDistanceobject

    Expected distance and driving time.

  • travellerobject
  • travelAddonsarray of objects
  • statusenum

    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.
  • cancellationDetailsobject

    Whether and until when the journey can be cancelled for free.

  • priceSummaryobject

    The price of the journey.

  • customerServiceInfoobject

    Transferz customer service contact for this journey.

  • travellerAppUrlstring

    Link to the traveller page where the traveller can follow the journey.

Errors this endpoint can return

  • 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.