TransferPlatform Ground Transport API
The TransferPlatform API gives you ground transfers from several providers through one contract:
- Airport transfers: airport ↔ hotel or address, arrival and departure.
- Point-to-point transfers: between two addresses, one way or round trip.
- Hourly hire: a car and driver for a number of hours.
Flow: search → recheck → book → booking details (voucher) → cancel. Each offer carries an opaque
offer_token (send it to recheck, then the recheck's offer_token to book); a booking returns a
supplier_reference (with an opaque booking_token) that you send back unchanged to booking details and cancel.
Tokens are encrypted, tied to your API key and cannot be edited; offer tokens expire 24 hours after the search.
Authentication: send your API key in the X-API-Key header on every request except GET /health.
Sandbox keys start with tp_test_, live keys with tp_live_. A sandbox key only ever reaches the providers'
test systems (no real bookings, nothing is charged), a live key only their production systems. A key used
on the other environment answers 401 unauthorized.
Errors: every 4xx / 5xx from the API uses {"error": {"code", "message", "provider", "request_id"}}
(422 validation_error adds details[]); provider failures arrive inside 200 responses (errors[] in search,
error elsewhere).
Request ids: every response carries X-Request-Id (also error.request_id); quote it to support. You may send
your own (8–128 characters A–Z a–z 0–9 . _ : -).
Limits: 600 requests per minute per API key (bursts up to 100; 429 rate_limited with Retry-After); request
bodies up to 256 KB (413 payload_too_large).
Currencies: every price is returned in the currency requested in the search, for every provider and every
call (recheck, book, booking details, refunds); the default is USD and an unsupported code answers
422 unsupported_currency. The price is locked at search time: recheck, book and refunds use the same price basis,
so a price only changes when the provider's own price changes.
Compatibility: within v1, new fields, enumeration values, error codes and providers may be added. Ignore
unknown fields and handle unknown values.
Examples are illustrative, based on test-environment responses with identifiers and personal data replaced; long arrays and provider-specific objects are trimmed. Guides (quickstart, booking flow, idempotency, errors, go-live checklist) are in the Guides section of the partner documentation site.
Authentication
- API Key: ApiKeyAuth
Your API key: tp_test_ + 43 characters (sandbox) or tp_live_ + 43 characters (live).
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
Contact
Pathfndr partner support: [email protected]