TRANSFERISE PARTNER API · V1 · REFERENCE

Airport transfer API documentation

Search places, get live prices, create, change and cancel private airport transfers with one JSON API. Every request below shows the call on the right and exactly what comes back. Build with a free sandbox key; nothing reaches drivers or payments until you go live.

27airports
11countries
7endpoints
JSONREST · HTTPS
Freesandbox

Quickstart

Three calls take a traveller from "where to?" to a booked transfer.

  1. 1
    Find the placesplaces turns "AYT" or a hotel name into a place id.
  2. 2
    Show live pricesquote returns every vehicle with its final price.
  3. 3
    Bookbook creates the booking and, when needed, a secure card payment link.

Authentication & sandbox

Send your key in the X-Api-Key header. All requests and responses are JSON (UTF-8).

Base URL
https://transferise.com/api/widget.php?action=…
Sandbox key
tfx_test_…. Same places, prices and validation as live. Bookings are TEST-…, visible only to you. No drivers, no payments, no e-mails.
Live key
tfx_…. Issued after a short review in the partner console. It can be locked to your domains.
Security
Call book, update and cancel from your server, never from the browser. Never put a live key in client code or a public repository.
curl 'https://transferise.com/api/widget.php?action=places&q=antalya' \
  -H 'X-Api-Key: tfx_test_…'
Without a valid key → 401
{
    "ok": false,
    "error": "invalid_api_key",
    "docs": "https://transferise.com/developers/docs"
}

Booking flow

A booking moves through these statuses. booking always returns the current one.

quoteprice shown
→
pending_paymenttraveller pays on payment_url
→
confirmede-mail sent to traveller
→
assigneddriver allocated
→
completedtransfer done

cancelled can happen per leg or for the whole booking until the cancellation window closes.

GET?action=places

Search places

Find an airport, hotel, resort or address. Use the returned id in quote and book.

ParameterType
qrequiredstringSearch text, at least 2 characters
What happens
  • Read-only. Nothing is stored.
  • Returns up to 10 matches with coordinates.
  • Places that are not in our list can still be booked with from_lat / from_lng / from_label.
curl 'https://transferise.com/api/widget.php?action=places&q=rixos+downtown' \
  -H 'X-Api-Key: tfx_test_…'
const res = await fetch(
  'https://transferise.com/api/widget.php?action=places&q=rixos+downtown',
  { headers: { 'X-Api-Key': process.env.TRANSFERISE_KEY } }
);
const data = await res.json();
$ch = curl_init('https://transferise.com/api/widget.php?action=places&q=rixos+downtown');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('TRANSFERISE_KEY')],
]);
$data = json_decode(curl_exec($ch), true);
Response · 200 OK
{
    "ok": true,
    "results": [
        {
            "id": "hotel:17370",
            "kind": "hotel",
            "name": "Rixos Downtown Antalya",
            "label": "Rixos Downtown Antalya, Antalya City, Antalya, Türkiye",
            "iata": null,
            "lat": 36.8774,
            "lng": 30.6656
        }
    ]
}
GET?action=quote

Get live prices

Prices and vehicles for one trip. Prices are final, per vehicle unless pricing is per_person.

ParameterType
from, torequiredplace idFrom places, e.g. airport:68. Or use from_lat, from_lng, from_label.
date, timerequiredYYYY-MM-DD, HH:MMLocal pickup time
passengersint1–30, default 2
round, return_date, return_time1 + date/timeRound trip
currencyEUR · GBP · USD · TRY …Default EUR
langen · tr · de · ruLanguage of names and links
What happens
  • Prices are calculated with the same rules as our website. Nothing is booked.
  • payment_methods lists what the traveller can use for each vehicle.
  • booking_url opens our checkout with your partner code. Bookings made within 30 days are credited to you.
curl 'https://transferise.com/api/widget.php?action=quote&from=airport%3A68&to=hotel%3A17370&date=2026-12-02&time=14%3A00&passengers=2&currency=GBP' \
  -H 'X-Api-Key: tfx_test_…'
const res = await fetch(
  'https://transferise.com/api/widget.php?action=quote&from=airport%3A68&to=hotel%3A17370&date=2026-12-02&time=14%3A00&passengers=2&currency=GBP',
  { headers: { 'X-Api-Key': process.env.TRANSFERISE_KEY } }
);
const data = await res.json();
$ch = curl_init('https://transferise.com/api/widget.php?action=quote&from=airport%3A68&to=hotel%3A17370&date=2026-12-02&time=14%3A00&passengers=2&currency=GBP');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('TRANSFERISE_KEY')],
]);
$data = json_decode(curl_exec($ch), true);
Response · 200 OK
{
    "ok": true,
    "test": false,
    "from": "Antalya Airport (AYT)",
    "to": "Rixos Downtown Antalya",
    "date": "2026-12-02",
    "time": "14:00",
    "passengers": 2,
    "round_trip": false,
    "vehicles": [
        {
            "id": 60,
            "name": "Standard Sedan",
            "type": "private",
            "pricing": "per_vehicle",
            "max_passengers": 3,
            "max_luggage": 3,
            "price": 25.04,
            "currency": "GBP",
            "price_eur": 30,
            "payment_methods": [
                "iyzico_full"
            ]
        }
    ],
    "booking_url": "https://transferise.com/search?from=…&ref=p12&utm_source=partner&utm_medium=widget&utm_content=api"
}
POST?action=book

Create a booking

Book a vehicle from a fresh quote. Minimum notice and route checks are the same as on our website.

ParameterType
vehicle_idrequiredintFrom quote
from, to, date, timerequiredSame as quote
customerrequiredobjectfirst_name, last_name, email, phone
adults, children, infantsintPassenger split
round_trip, return_date, return_timeRound trip
flight_number, hotel, notesstringHelps the driver
payment_methodstringOne of the quote's payment_methods
partner_referencestring ≤ 64Your own id. Repeating it returns the existing booking.
What happens
  • A booking with its own reference is created. With a sandbox key it is a TEST-… booking only you can see.
  • API bookings are currently paid in full by card. The booking stays pending_payment until the traveller pays on payment_url (3-D Secure), then becomes confirmed.
  • The traveller receives our confirmation e-mail. Our operations team assigns the driver.
  • Retrying with the same partner_reference never creates a second booking.
curl -X POST 'https://transferise.com/api/widget.php?action=book' \
  -H 'X-Api-Key: tfx_test_…' \
  -H 'Content-Type: application/json' \
  -d '{"vehicle_id":60,"from":"airport:68","to":"hotel:17370","date":"2026-12-02","time":"14:00","round_trip":true,"return_date":"2026-12-09","return_time":"10:00","adults":2,"currency":"GBP","lang":"en","customer":{"first_name":"Anna","last_name":"Smith","email":"anna@example.com","phone":"+447700900123"},"flight_number":"TK123","payment_method":"iyzico_full","partner_reference":"ARF-1001"}'
const res = await fetch('https://transferise.com/api/widget.php?action=book', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.TRANSFERISE_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "vehicle_id": 60,
    "from": "airport:68",
    "to": "hotel:17370",
    "date": "2026-12-02",
    "time": "14:00",
    "round_trip": true,
    "return_date": "2026-12-09",
    "return_time": "10:00",
    "adults": 2,
    "currency": "GBP",
    "lang": "en",
    "customer": {
        "first_name": "Anna",
        "last_name": "Smith",
        "email": "anna@example.com",
        "phone": "+447700900123"
    },
    "flight_number": "TK123",
    "payment_method": "iyzico_full",
    "partner_reference": "ARF-1001"
}),
});
const data = await res.json();
$ch = curl_init('https://transferise.com/api/widget.php?action=book');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('TRANSFERISE_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => json_encode([
  'vehicle_id' => 60,
  'from' => 'airport:68',
  'to' => 'hotel:17370',
  'date' => '2026-12-02',
  'time' => '14:00',
  'round_trip' => true,
  'return_date' => '2026-12-09',
  'return_time' => '10:00',
  'adults' => 2,
  'currency' => 'GBP',
  'lang' => 'en',
  'customer' => [
    'first_name' => 'Anna',
    'last_name' => 'Smith',
    'email' => 'anna@example.com',
    'phone' => '+447700900123',
  ],
  'flight_number' => 'TK123',
  'payment_method' => 'iyzico_full',
  'partner_reference' => 'ARF-1001',
]),
]);
$data = json_decode(curl_exec($ch), true);
Response · 201 Created
{
    "ok": true,
    "booking": {
        "reference": "TRS-7F3A21C",
        "status": "pending_payment",
        "payment_method": "iyzico_full",
        "payment_status": "pending",
        "total": 50.08,
        "currency": "GBP",
        "vehicle": {
            "id": 60,
            "name": "Standard Sedan"
        },
        "round_trip": true,
        "passengers": {
            "adults": 2,
            "children": 0,
            "infants": 0,
            "total": 2
        },
        "customer": {
            "first_name": "Anna",
            "last_name": "Smith",
            "email": "anna@example.com",
            "phone": "+447700900123"
        },
        "notes": "",
        "legs": [
            {
                "id": 9812,
                "type": "outbound",
                "status": "confirmed",
                "from": "Antalya Airport (AYT)",
                "to": "Rixos Downtown Antalya",
                "pickup_date": "2026-12-02",
                "pickup_time": "14:00",
                "flight_number": "TK123",
                "hotel": "",
                "can_modify": true,
                "hours_until_pickup": 331.5
            },
            {
                "id": 9813,
                "type": "return",
                "status": "confirmed",
                "from": "Rixos Downtown Antalya",
                "to": "Antalya Airport (AYT)",
                "pickup_date": "2026-12-09",
                "pickup_time": "10:00",
                "flight_number": "",
                "hotel": "",
                "can_modify": true,
                "hours_until_pickup": 499.5
            }
        ],
        "payment_url": "https://transferise.com/payment/iyzico/TRS-7F3A21C",
        "manage_url": "https://transferise.com/my-booking",
        "partner_reference": "ARF-1001",
        "test": false
    }
}
GET?action=booking

Get a booking

One booking you created, with the live status of every leg (outbound and return).

ParameterType
referencerequiredstringOr partner_reference
What happens
  • Read-only. Nothing is stored.
  • Each leg shows status, can_modify and hours_until_pickup.
  • Poll this, or use the Supabase kit's sync, to follow status changes.
curl 'https://transferise.com/api/widget.php?action=booking&reference=TRS-7F3A21C' \
  -H 'X-Api-Key: tfx_test_…'
const res = await fetch(
  'https://transferise.com/api/widget.php?action=booking&reference=TRS-7F3A21C',
  { headers: { 'X-Api-Key': process.env.TRANSFERISE_KEY } }
);
const data = await res.json();
$ch = curl_init('https://transferise.com/api/widget.php?action=booking&reference=TRS-7F3A21C');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('TRANSFERISE_KEY')],
]);
$data = json_decode(curl_exec($ch), true);
Response · 200 OK
{ "ok": true, "booking": { … same shape as book … } }
GET?action=bookings

List bookings

Your bookings by pickup date, 50 per page.

ParameterType
from, toYYYY-MM-DDDefault −30 / +365 days
pageintDefault 1
What happens
  • Read-only. Nothing is stored.
  • Only bookings made with your keys are listed.
curl 'https://transferise.com/api/widget.php?action=bookings&from=2026-11-01&to=2027-01-31' \
  -H 'X-Api-Key: tfx_test_…'
const res = await fetch(
  'https://transferise.com/api/widget.php?action=bookings&from=2026-11-01&to=2027-01-31',
  { headers: { 'X-Api-Key': process.env.TRANSFERISE_KEY } }
);
const data = await res.json();
$ch = curl_init('https://transferise.com/api/widget.php?action=bookings&from=2026-11-01&to=2027-01-31');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('TRANSFERISE_KEY')],
]);
$data = json_decode(curl_exec($ch), true);
Response · 200 OK
{ "ok": true, "page": 1, "per_page": 50, "bookings": [ … ] }
POST?action=update

Change a booking

Change pickup date or time, flight number, hotel or notes of one leg.

ParameterType
referencerequiredstringOr partner_reference
leg_idintDefault: outbound leg
pickup_date, pickup_time, flight_number, hotel, notesFields to change
What happens
  • The leg is updated straight away.
  • The traveller, the driver and our team are notified automatically.
  • Allowed until the change window closes (24 h before pickup by default). After that you get 409 not_modifiable.
curl -X POST 'https://transferise.com/api/widget.php?action=update' \
  -H 'X-Api-Key: tfx_test_…' \
  -H 'Content-Type: application/json' \
  -d '{"reference":"TRS-7F3A21C","leg_id":9812,"pickup_time":"15:30","flight_number":"TK999"}'
const res = await fetch('https://transferise.com/api/widget.php?action=update', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.TRANSFERISE_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "reference": "TRS-7F3A21C",
    "leg_id": 9812,
    "pickup_time": "15:30",
    "flight_number": "TK999"
}),
});
const data = await res.json();
$ch = curl_init('https://transferise.com/api/widget.php?action=update');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('TRANSFERISE_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => json_encode([
  'reference' => 'TRS-7F3A21C',
  'leg_id' => 9812,
  'pickup_time' => '15:30',
  'flight_number' => 'TK999',
]),
]);
$data = json_decode(curl_exec($ch), true);
Response · 200 OK
{ "ok": true, "booking": { … } }
POST?action=cancel

Cancel a booking

Cancel one leg (leg_id) or the whole booking (no leg_id).

ParameterType
referencerequiredstringOr partner_reference
leg_idintCancel only this leg
What happens
  • The leg or the booking becomes cancelled, and the driver is released.
  • Free until the cancellation window closes. Card payments are refunded under our refund policy.
  • The traveller is notified.
curl -X POST 'https://transferise.com/api/widget.php?action=cancel' \
  -H 'X-Api-Key: tfx_test_…' \
  -H 'Content-Type: application/json' \
  -d '{"reference":"TRS-7F3A21C"}'
const res = await fetch('https://transferise.com/api/widget.php?action=cancel', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.TRANSFERISE_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "reference": "TRS-7F3A21C"
}),
});
const data = await res.json();
$ch = curl_init('https://transferise.com/api/widget.php?action=cancel');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ['X-Api-Key: ' . getenv('TRANSFERISE_KEY'), 'Content-Type: application/json'],
  CURLOPT_POSTFIELDS => json_encode([
  'reference' => 'TRS-7F3A21C',
]),
]);
$data = json_decode(curl_exec($ch), true);
Response · 200 OK
{ "ok": true, "booking": { "status": "cancelled", … } }
Integration

Transferise for Supabase

An open-source kit (MIT) that adds airport transfers to any app built on Supabase. It stores bookings in your own Supabase database with Row Level Security, and pushes every status change to your app over Supabase Realtime. No booking backend to build.

Your appsupabase-js
invoke →
Edge Functiontransferise
X-Api-Key →
Transferise APIquote · book · cancel
Postgres + RLStransferise_bookings
pg_cron syncevery 5 minutes
Realtimelive status in your UI

Bookings in your database

A migration creates transferise_bookings and a status history table. Query them like any other table.

Live status

A scheduled function refreshes open bookings. Realtime pushes confirmed → assigned → completed to the signed-in owner.

Secure by default

RLS lets users read only their own rows, and nobody writes from the browser. The API key stays an Edge Function secret. Traveller e-mail and phone are not stored.

1. Install

Get a sandbox key, then apply the migration, set the secrets and deploy the two functions.

What happens
  • Two tables with RLS, triggers and Realtime are added to your project.
  • transferise (JWT required) and transferise-sync (shared secret) are deployed.
  • Your key is stored only as a function secret.
supabase link --project-ref <project-ref>
supabase db push

supabase secrets set \
  TRANSFERISE_API_KEY=tfx_test_xxx \
  SYNC_SECRET=$(openssl rand -hex 24)

supabase functions deploy transferise
supabase functions deploy transferise-sync --no-verify-jwt
Result
Applying migration 20261113000000_transferise.sql...
Finished supabase db push.
Finished supabase secrets set.
Deployed Functions: transferise, transferise-sync

2. Quote and book from your app

Call the Edge Function with supabase.functions.invoke. The signed-in user becomes the owner of the booking.

What happens
  • The function checks the user's JWT and calls the Transferise API with your secret key.
  • A row is written to transferise_bookings with the reference, route, time, price and status.
  • If the booking needs card payment, payment_url is returned for the traveller.
const { data: quote } = await supabase.functions.invoke('transferise', {
  body: { action: 'quote', from: 'airport:68', to: 'hotel:17370',
          date: '2026-12-02', time: '14:00', passengers: 2 },
});

const { data } = await supabase.functions.invoke('transferise', {
  body: {
    action: 'book', from: 'airport:68', to: 'hotel:17370',
    date: '2026-12-02', time: '14:00', passengers: 2,
    vehicle_id: quote.vehicles[0].id, flight_number: 'TK123',
    customer: { first_name: 'Anna', last_name: 'Smith',
                email: 'anna@example.com', phone: '+447700900123' },
  },
});
if (data.booking.payment_url) location.href = data.booking.payment_url;
Row saved in your database
{
    "booking": {
        "id": "7b1c…",
        "reference": "TRS-7F3A21C",
        "status": "pending_payment",
        "from_label": "Antalya Airport (AYT)",
        "to_label": "Rixos Downtown Antalya",
        "pickup_date": "2026-12-02",
        "pickup_time": "14:00:00",
        "total": 25.04,
        "currency": "GBP",
        "payment_url": "https://transferise.com/payment/iyzico/TRS-7F3A21C"
    }
}

3. Show live status

Subscribe to changes. RLS makes sure each user only receives their own bookings.

What happens
  • transferise-sync runs every 5 minutes via pg_cron and refreshes open bookings.
  • Every status change is written to the table and to transferise_booking_events.
  • Realtime pushes the update to the browser. No polling in your app.
supabase
  .channel('my-transfers')
  .on('postgres_changes',
    { event: 'UPDATE', schema: 'public', table: 'transferise_bookings' },
    (p) => updateCard(p.new.reference, p.new.status))
  .subscribe();
Realtime event your app receives
{
    "eventType": "UPDATE",
    "table": "transferise_bookings",
    "old": {
        "status": "confirmed"
    },
    "new": {
        "reference": "TRS-7F3A21C",
        "status": "assigned",
        "pickup_date": "2026-12-02",
        "pickup_time": "14:00:00"
    }
}
What is in the kit
  • supabase/migrations/…_transferise.sql tables, triggers, RLS, Realtime
  • supabase/functions/transferise/ places · quote · book · status · cancel
  • supabase/functions/transferise-sync/ status sync
  • supabase/cron.sql pg_cron + Vault
  • tests/ SQL/RLS, unit, sandbox

Errors

Errors return {"ok": false, "error": "…"} with an HTTP status. Some include a human-readable message.

HTTPerrorMeaning
401invalid_api_keyMissing or wrong key, or the request comes from a domain the live key is not locked to.
400from_to_required · reference_required · q_too_shortA required parameter is missing.
404booking_not_found · leg_not_foundNot one of your bookings, or wrong leg id.
405use_postbook, update and cancel need POST.
409not_modifiable · already_cancelledThe change or cancellation window has closed, or the booking is already cancelled.
422booking_rejectedmessage explains why: price changed (quote again), notice too short, contact data missing…
429rate_limited120 requests/min per key; 30 bookings/hour per live key.

Booking rules

  • Payment: cash_driver (pay the driver), iyzico_split (deposit by card, rest in cash), iyzico_full (full card payment). Only the codes in the quote's payment_methods are accepted. API bookings currently use iyzico_full.
  • Changes and cancellation: free until the window closes (24 h before each pickup by default). After that, use manage_url or contact support.
  • Traveller communication: the traveller receives our confirmation e-mail with driver details and the My Booking link. Changes made through the API notify the traveller and the driver.
  • Attribution: bookings created with your key, and bookings made within 30 days after a traveller opens your booking_url, carry your partner code.
  • Fair use: Acceptable Use Policy

Ready to build?

Get a sandbox key in minutes and make your first booking today. Live keys are issued after a short review.

Get a sandbox key →