Skip to content

The journey lifecycle

A journey from assignment to completion, what your integration does at each stage, and the statuses it moves through.

Updated · 2 min read

This page explains how a journey booked by a partner ends up with your company, and what your integration does from that moment until the journey is completed. Read it before the task guides in this section.

How a journey becomes yours

A traveller books a ride through a partner, for example from Amsterdam Airport Schiphol to a hotel in the city. Transferz then assigns the journey to one of your fleets. You do not have to do anything to get it. Transferz can also assign a journey to you by hand.

When a journey is assigned to your fleet, you receive journeyFleetAssignedEvent. You then fetch the journey and plan it.

What you do with a journey

Once a journey is yours, your integration:

  1. Receives the journey by webhook and fetches its details with Get a journey.
  2. Assigns a driver and a vehicle. The journey moves from CONFIRMED to PLANNED.
  3. Reports progress: driver underway, driver arrived, traveller on board, and the driver's position on the way. Or your drivers use the Transferz Driver App, which does this for you.
  4. Completes the journey after the drop-off.

Along the way you may also need to:

The statuses you see

A journey's status tells you where it is. As a transfer company you see these:

StatusWhat it means for youWho sets it
CONFIRMEDThe journey is yours. It still needs a driver.Transferz
PLANNEDA driver is assigned.Transferz, when you assign a driver
DRIVER_UNDERWAYThe driver is on the way to the pickup.You or the Driver App
DRIVER_ARRIVEDThe driver is at the pickup.You, the Driver App, or Transferz from the driver's position
JOURNEY_IN_PROGRESSThe traveller is on board.You or the Driver App
COMPLETEDThe traveller was dropped off.You, the Driver App, or Transferz from the driver's position
CANCELLED_FREECancelled; you are not paid for it.Transferz
CANCELLED_WITH_COSTSCancelled; you are paid for it.Transferz

Journeys in the early statuses (NOT_PAID, AWAITING_APPROVAL, PENDING) are not yet yours, and you receive no status events for them. COMPLETED and the two cancelled statuses are final. All values are explained in Constants.

Before you start

You need:

Then continue with Receive journeys.

Was this helpful?