Constants
Every journey status, vehicle category, add-on, cancellation reason and decline reason, with what each value means.
The APIs use fixed values for statuses, categories and reasons. This page lists each value and what it means. The values are the same in the Partners and the Transfer Companies API. New values can be added; handle a value you do not know without failing, for example by treating it as "other".
Journey status
A journey moves through these statuses. The usual path is:
NOT_PAID → PENDING → CONFIRMED → PLANNED → DRIVER_UNDERWAY → DRIVER_ARRIVED →
JOURNEY_IN_PROGRESS → COMPLETED
| Status | Meaning |
|---|---|
NOT_PAID | The journey was booked but not paid yet. |
AWAITING_APPROVAL | Paid, but held for a check by Transferz before it continues. Transfer companies do not see these journeys in a search by default. |
PENDING | Paid and approved; waiting for a transfer company. |
CONFIRMED | A transfer company has the journey. It still needs a driver (and, for some journeys, a meeting point). |
PLANNED | A driver is assigned and, where needed, a meeting point is set. Set automatically from CONFIRMED. |
DRIVER_UNDERWAY | The driver is on the way to the pickup. Transferz sends the traveller the driver's details. |
DRIVER_ARRIVED | The driver is at the pickup location. |
JOURNEY_IN_PROGRESS | The traveller is on board. |
COMPLETED | The journey is finished. |
CANCELLED_FREE | Cancelled without charge to the partner. |
CANCELLED_WITH_COSTS | Cancelled with a charge to the partner. |
BOOKER_CANCELLED | Deprecated. No journey has this status any more; existing ones became CANCELLED_FREE. |
SUPPLIER_CANCELLED | Deprecated. No journey has this status any more; existing ones became CANCELLED_FREE. |
Rules worth knowing:
COMPLETEDand the cancelled statuses are final. A journey in a final status does not change again.- A journey can skip statuses, and a driver or vehicle being removed moves
PLANNEDback toCONFIRMED. Do not assume each status is reached, or reached once. - A journey can be cancelled up to
DRIVER_ARRIVED, not once it isJOURNEY_IN_PROGRESS. - Transfer companies set
DRIVER_UNDERWAY,DRIVER_ARRIVEDandJOURNEY_IN_PROGRESSwith the status endpoints, which need a pickup within the next 48 hours, andCOMPLETEDwith the complete endpoint, which works from the pickup time on. The status endpoints also accept a journey without a driver; assign the driver first anyway, so the traveller knows who to look for.
Free and paid cancellation
A cancellation is free when the journey is NOT_PAID, AWAITING_APPROVAL or PENDING, or when it
happens before the free-cancellation deadline. Quotes and journeys show that deadline as
freeCancellationUntil. After the deadline a partner must set acceptCharges to true to cancel,
and the journey becomes CANCELLED_WITH_COSTS.
Vehicle category
Quotes and journeys have a vehicleCategory. Shared categories carry several parties in one vehicle;
their quotes are priced per passenger (pricePerPassenger is true).
| Category | Kind |
|---|---|
ECONOMY_SEDAN | Private |
SEDAN | Private |
BUSINESS_SEDAN | Private |
LUXURY_SEDAN | Private |
STATIONWAGON | Private |
SUV | Private |
MPV | Private |
MINIVAN | Private |
EXCLUSIVE_MINIVAN | Private |
VAN | Private |
MINIBUS | Private |
BUS | Private |
COACH | Private |
STANDARD_ELECTRIC_CAR | Private |
HIGH_END_ELECTRIC_CAR | Private |
STRETCH_LIMOUSINE | Private |
HELICOPTER | Private |
SHUTTLE | Shared |
SPEEDY_SHUTTLE | Shared |
EVENT_SHUTTLE | Shared |
DIRECT_SHUTTLE | Shared |
BUSINESS_LIMOUSINE | Deprecated; not quoted any more |
TOURING_CAR | Deprecated; not quoted any more |
Each quote states its own passengerCapacity and luggageCapacity; use those rather than assumptions
about a category.
Travel add-ons
Add-ons are extras on a journey. Each quote lists the add-ons available for it in
availableTravelAddons, with a price and the maximum quantity (maxAllowed).
| Add-on | Meaning |
|---|---|
MEET_GREET | A host meets the traveller at the pickup. Offered on some journeys only. |
BABY_SEAT | A baby seat, per seat. |
CHILD_SEAT | A child seat, per seat. |
BOOSTER_SEAT | A booster seat, per seat. |
PETS | The traveller brings pets. |
EXTRA_STOP | An extra stop on the way. |
SPECIAL_LUGGAGE | Luggage that needs extra room, per item. |
CARBON_EMISSION_COMPENSATION | Compensation for the journey's carbon emissions. It cannot be added in a journey change. |
Cancellation reasons
Partners give one of these as reason when they cancel a journey or a booking.
| Reason | Use when |
|---|---|
NOT_NEEDED_ANYMORE | The traveller no longer needs the transfer. |
DRIVER_NO_SHOW | The driver did not turn up. |
TRAVELLER_NO_SHOW | The traveller did not turn up. |
NO_AVAILABILITY | No vehicle was available. |
ADDRESS_INVALID | The address is wrong. |
INSUFFICIENT_TRAVELLER_DETAILS | Traveller details are missing. |
NO_FLIGHT_NUMBER | The flight number is missing. |
PAX_BAGS_CONFIGURATION | The passengers or luggage do not fit the booking. |
ADD_ON_ISSUE | A problem with an add-on. |
CANT_FULFILL_CUSTOMER_REQUEST | A request of the traveller cannot be met. |
PRICE_CALCULATION_ERROR | The price was wrong. |
TECHNICAL_ISSUE | A technical problem. |
STRIKE_OR_ROAD_CLOSURE | A strike or a closed road. |
FORCE_MAJEURE | Circumstances beyond anyone's control. |
OTHER | None of the above. |
Offer decline reasons
Transfer companies give one of these as reason when they decline an offer. With OTHER, a
description is required.
| Reason | Use when |
|---|---|
FARE_TOO_LOW | The fare is too low. |
NO_VEHICLE_AVAILABILITY | No suitable vehicle is free. |
NO_DRIVER_AVAILABILITY | No driver is free. |
ADDONS_NOT_AVAILABLE | You cannot provide a requested add-on. |
INCORRECT_JOURNEY_DETAILS | The journey details are wrong. |
DISTANCE_TOO_SHORT_OR_LONG | The distance is outside what you drive. |
HOLIDAY | You do not operate on that day. |
STRIKE | A strike prevents the ride. |
OTHER | None of the above; explain in description. |
The meanings in the two reason tables follow the value names; Transferz has not documented them further.
Offer status
| Status | Meaning |
|---|---|
PENDING | Created; you have not been notified yet. You can accept it. |
NOTIFIED | You were notified. You can accept it. |
SKIPPED_NOTIFICATION | No notification was sent, but you can accept it. |
ACCEPTED | You accepted it. Final. |
DECLINED | You declined it. Final. |
EXPIRED | Nobody accepted it in time. Final. |
MISSED | Another transfer company accepted it, or the journey was cancelled. Final. |
When you accept, give the meeting point type HUB or TRANSFER_COMPANY where a meeting point is
needed.
Action types
Transfer companies report incidents as actions. The API accepts two types; the other two are listed in the specification but set by other Transferz systems.
| Type | Meaning |
|---|---|
TRAVELLER_NO_SHOW | The traveller did not show up. Add photo evidence. Accepted by the API. |
DRIVER_LEFT_PICKUP | The driver left the pickup location. Accepted by the API. |
DRIVER_DELAYED | The driver is late; the traveller gets a message. Not accepted by the API. |
ADDITIONAL_PROOF_TRAVELLER_NO_SHOW | Extra evidence for a no-show. Not accepted by the API. |
Journey assignment status
Transfer Companies API journeys have an assignmentStatus:
| Status | Meaning |
|---|---|
NOT_ASSIGNED | No transfer company has the journey. |
ASSIGNED | The journey is assigned to your company. |
REASSIGNED | The journey now belongs to another transfer company. |
Other values
| Field | Values | Meaning |
|---|---|---|
Journey type | HUB, POINT_TO_POINT | A ride to or from a hub, or between two other places. |
distanceUnit | METER, KILOMETER, FEET, MILE | The unit of a distance. |
travelIntent | BUSINESS, LEISURE, UNKNOWN | Why the traveller travels, if known. |
pickupTimeAdjustmentMethod | PENDING, NONE, FLIGHT_TRACKING, MANUAL | How the pickup time follows the flight: not decided yet, not adjusted, by flight tracking, or by hand. |
usedResolutionMethod | IATA_CODE, ICAO_CODE, ADDRESS_PHRASE, COORDINATES, TRANSFERZ_LOCATION_ID, GOOGLE_PLACE_ID, HERE_ID, TOMTOM_ID, GIATA_ID, TTI_CODE | Which part of your location input Transferz used. |
Meeting point file fileType | MAP, DESK, PICKUP, OTHER | What a meeting point image shows. |