Skip to main content

TransferPlatform API

The TransferPlatform API gives you one REST/JSON interface to sell private ground transport: airport transfers, point-to-point (city-to-city) rides and hourly chauffeur hire. You search once, get a single list of offers from every transport provider enabled for your account, then recheck, book, read and cancel bookings through the same five calls, whichever provider fulfils the ride.

New here? The Quickstart takes you from a sandbox key to a confirmed (and cancelled) test booking in about five minutes, with copy-paste samples in curl, Python and Node.js.

API v1OpenAPI 3.1JSON over HTTPSDocs 1.2.1

How it works​

  1. Search returns offers from all your enabled providers, priced in the currency you ask for and sorted cheapest first.
  2. Recheck the chosen offer right before booking: it confirms availability and the current price.
  3. Book with your own order reference. Book is idempotent, so a retry never books twice.
  4. Booking details returns the booking in one unified shape for every provider: render your own voucher from it.
  5. Cancel when the customer cancels; the refund is reported in the booking's currency.

Endpoints​

EndpointWhat it does
POST/v1/searchSearch offers for an airport, point-to-point or hourly transfer
POST/v1/transfer/recheckConfirm availability and the current price of an offer
POST/v1/transfer/bookBook an offer
POST/v1/transfer/booking-detailsRead a booking (status, trip, driver, cancellation)
POST/v1/transfer/cancelCancel a booking
GET/healthLiveness check (no API key)

POST /v1/transfer/voucher still works but is deprecated: it is an alias of booking details.

Transfer types​

transfer_typeWhat it isLegs returned
airport (default)From an airport to an address, from an address to an airport, or both in one searcharrival, departure
point_to_point (alias intercity)Address to address, one way or round tripoutbound; round trips add return and, where a provider sells it, a single round_trip package
hourlyA car and driver at the customer's disposal for 1 to 24 hoursoutbound

Details and request rules: Transfer types.

Conventions​

  • Base URLs. Sandbox https://transfers-sandbox.pathfndr.io, live https://transfers.pathfndr.io (Environments).
  • Authentication. An API key in the X-API-Key header (Authentication).
  • JSON over HTTPS, UTF-8. Send Content-Type: application/json on every POST. Field names are snake_case.
  • Unknown values are null, never invented. Ignore response fields you do not know: new fields and enum values can appear within v1.
  • Dates and times are local to the pickup; timestamps the platform creates are UTC (Dates and formats).
  • Prices are in the currency you search with, for every provider and every call (Currency).
  • Every response carries an X-Request-Id header (Request IDs).
GEThttps://transfers-sandbox.pathfndr.io/health
Check the API is reachable
curl -s https://transfers-sandbox.pathfndr.io/health
200 OK
{"status": "healthy"}

Downloads​

More on the Downloads page. Questions? See Support.