Skip to main content

TransferOffer

One bookable vehicle option for one leg, from one provider.

providerstringrequired

Provider of the offer. Send it as provider_context.provider.

Example: provider_d
transfer_typestring

airport, point_to_point or hourly.

Default value: airport
Example: airport
directionstringrequired

Airport: arrival or departure. Point-to-point and hourly: the leg (outbound, return, round_trip).

Example: arrival
offer_idstringrequired

Id of the offer within this search response. A new id is generated on every search: do not store it across searches.

Example: 1421a5071cc20000
rate_keystringrequired

Send it as provider_context.rate_key to recheck and book.

Example: 7
offer_tokenstring | nullnullable

Opaque, encrypted string. Store it and send it back unchanged; it cannot be read or edited (a modified token is rejected with 422). Send it as provider_context.offer_token to recheck. Valid for 24 hours from the search (409 offer_expired afterwards); only for your API key.

Example: ot1.gAAAAAB...opaque-offer-token...(about 1 kB; trimmed in this example)
price objectrequired

Price for the vehicle.

totalnumberrequired

Total price for the vehicle.

Example: 1317
currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR
taxes_includedboolean

Always true: prices include taxes.

Default value: true
Example: true
vehicle object

Vehicle category.

anyOf

Vehicle category of the offer. category is the provider's own wording.

categorystring | nullnullable

Provider's vehicle category, free text, not normalised.

Example: AC SUV Large
modelstring | nullnullable

Example model, "or similar".

Example: Ertiga or similar
image_urlstring | nullnullable

Picture of the category.

Example: https://images.example.com/vehicles/ac-suv-large.png
max_passengersinteger | nullnullable

Seats.

Example: 6
max_bagsinteger | nullnullable

Suitcases.

Example: 2
duration_minutesinteger | nullnullable

Estimated ride time, when known.

Example: 25
distance_metersinteger | nullnullable

Route distance, when known.

Example: 148000
cancellation_summarystring | nullnullable

Cancellation terms in words, when known.

Example: 100% refund if cancelled at least 24h before pickup
flight_info_requiredboolean

true: flight details are required at book.

Default value: false
Example: false
legstring | nullnullable

Point-to-point and hourly: outbound, return (of a round trip searched as two legs) or round_trip (a round trip sold as one leg). null for airport offers.

Possible values: [outbound, return, round_trip]

Example: outbound
pickup_datetimestring | nullnullable

Pickup of this leg, local, YYYY-MM-DDTHH:MM. null for airport offers.

Example: 2026-11-27T09:00
pricing_modelstring

fixed_route: price for the route. hourly_package: hours (and km) included. outstation_package: multi-day or long-distance package with a kilometre allowance, extra km charged.

Possible values: [fixed_route, hourly_package, outstation_package]

Default value: fixed_route
Example: fixed_route
package object

What the package includes (hourly and package offers).

anyOf

What an hourly or rental package includes.

hours_includednumber | nullnullable

Hours included.

Example: 4
km_includednumber | nullnullable

Kilometres included.

Example: 40
daysinteger | nullnullable

Days included (multi-day round trips).

Example: 3
codestring | nullnullable

Provider package code.

Example: oneWay
labelstring | nullnullable

Provider package label, for example Local (8hr/80 km).

Example: Outstation (150 km)
extra_charges object

Charges payable beyond the package.

anyOf

Charges payable beyond the package.

extra_km_rate object

Per extra kilometre.

anyOf

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18
currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR
extra_hour_rate object

Per extra hour.

anyOf

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18
currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR
night_charge object

Night charge.

anyOf

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18
currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR
driver_allowance object

Driver allowance.

anyOf

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18
currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR
inclusions object

What the price includes or excludes.

anyOf

What the price includes or excludes.

tollsboolean | nullnullable

Tolls included.

Example: true
state_taxboolean | nullnullable

State taxes included.

Example: true
parkingboolean | nullnullable

Parking included.

Example: false
driver_allowanceboolean | nullnullable

Driver allowance included.

Example: true
gratuityboolean | nullnullable

Gratuity included.

Example: false
includedstring[]

Included items, provider wording.

Example: ["Fuel Charges","Driver Allowance","Toll / State tax","GST (5%)"]
excludedstring[]

Excluded items, provider wording.

Example: ["Pay INR 18/km after 150 km","Multiple pickups/drops","Airport Entry/Parking"]
cancellation object

Cancellation terms. null for airport offers today: use cancellation_summary.

anyOf

Cancellation terms of the offer.

free_untilstring | nullnullable

Free cancellation until this pickup-local time, YYYY-MM-DDTHH:MM:SS, when known.

Example: 2026-11-26T10:30:00
free_cancellation_hoursnumber | nullnullable

Free cancellation up to this many hours before pickup.

Example: 6
rules object[]

Refund steps.

  • Array [
  • hours_before_pickupnumberrequired

    Hours before pickup.

    Example: 4
    refund_percentnumberrequired

    Refund in percent of the price.

    Example: 100
  • ]
  • policy_textstring | nullnullable

    Policy in words.

    Example: Free cancellation until 6h before pickup; later: INR 500 or 20% of the booking amount, whichever is less
    included_waiting_minutesinteger | nullnullable

    Waiting time included at pickup, when known.

    Example: 30
    TransferOffer
    {
    "provider": "provider_d",
    "transfer_type": "airport",
    "direction": "arrival",
    "offer_id": "1421a5071cc20000",
    "rate_key": "7",
    "offer_token": "ot1.gAAAAAB...opaque-offer-token...(about 1 kB; trimmed in this example)",
    "price": {
    "total": 1317,
    "currency": "INR",
    "taxes_included": true
    },
    "vehicle": {
    "category": "AC SUV Large",
    "model": "Ertiga or similar",
    "image_url": "https://images.example.com/vehicles/ac-suv-large.png",
    "max_passengers": 6,
    "max_bags": 2
    },
    "duration_minutes": 25,
    "distance_meters": 148000,
    "cancellation_summary": "100% refund if cancelled at least 24h before pickup",
    "flight_info_required": false,
    "leg": "outbound",
    "pickup_datetime": "2026-11-27T09:00",
    "pricing_model": "fixed_route",
    "package": {
    "hours_included": null,
    "km_included": null,
    "days": null,
    "code": "oneWay",
    "label": "Outstation (150 km)"
    },
    "extra_charges": {
    "extra_km_rate": {
    "amount": 18,
    "currency": "INR"
    },
    "extra_hour_rate": null,
    "night_charge": null,
    "driver_allowance": null
    },
    "inclusions": {
    "tolls": true,
    "state_tax": true,
    "parking": false,
    "driver_allowance": true,
    "gratuity": false,
    "included": [
    "Fuel Charges",
    "Driver Allowance",
    "Toll / State tax",
    "GST (5%)"
    ],
    "excluded": [
    "Pay INR 18/km after 150 km",
    "Multiple pickups/drops",
    "Airport Entry/Parking"
    ]
    },
    "cancellation": {
    "free_until": null,
    "free_cancellation_hours": 6,
    "rules": [],
    "policy_text": "Free cancellation until 6h before pickup; later: INR 500 or 20% of the booking amount, whichever is less"
    },
    "included_waiting_minutes": 30
    }