GET/v1/transfers/reservations/:reservationId

Get a transfer reservation

Read a single reservation by its reservation ID.

GET/v1/transfers/reservations/:reservationId

API console

Try it

Send a real request to the sandbox API and inspect the response.

Credentials

Profile code

Public key

Secret key

Path parameters

1 field

reservationIdstringRequired

Reservation ID

Reservation identifier returned when the booking was created. On the unified details endpoint, send only one of reservationId, confirmationNumber or searchId.

Query parameters

3 fields

gdsproviderenumRequired

GDS provider

Transfer content selector. Currently only 0.

currencystring ISO 4217Optional

Currency

Currency of the returned amounts. Must match the offer or reservation when one already exists.

languagestringOptional

Language

Legacy language field. Prefer the LANG or Accept-Language header.

cURL request

cURL

bash

curl -X GET 'https://api.sandbox.travelandz.com/v1/transfers/reservations/:reservationId?gdsprovider=0&currency=USD' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE'

Add your credentials to send a request.

This request needs identifiers or tokens from an earlier call. Run the previous step first, then paste its values here.

Response

Click "Try it!" to send a request and see the response here.

Read a single reservation by its reservation ID.

Authentication and headers

Header	Description
`Authorization`	`Bearer <secret_key>`. Keep the secret on the server and never write it to client logs.
`X-Travelandz-Id`	`<public_key>:<profile_code>`, where the persisted profile code has the form `dp_<12 alphanumeric>`.
`LANG`	Preferred locale header. `Accept-Language` is also supported.
`Content-Type`	`application/json` for requests with a JSON body.

Request

This endpoint takes no body. reservationId goes in the path and gdsprovider in the query.

Request Params Schema

reservationId

stringYes

Reservation identifier returned when the booking was created.

Request Query Params Schema

gdsprovider

enum

0

Yes

Transfer content selector. Currently 0.

currency

enum

EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN

Lowercase values are accepted and normalized. Defaults to USD on a new search and is inherited afterwards.

language

enum

en-USes-ESde-DEfr-FRpt-BRzh-CNit-IT

Legacy field. Prefer the LANG or Accept-Language header.

Success response

Returns one reservation object directly, not the reservation envelope used by the other read endpoints.

Response Body Schema

gdsprovider

enum

0

Yes

reservationId

stringYes

Persist this value; reservation reads and cancellation need it.

confirmationNumber

stringNo

Traveller-facing confirmation code.

status

enum

completedpendingfailed

Yes

cancelled

booleanYes

totalAmount

numberYes

Total charged for the reservation.

currency

enum

EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN

Yes

pickupInstructions

stringNo

ticketUrl

string

Format: URL

selectedScheduleIndex

numberNo

departureDatetime

string

Format: ISO 8601

arrivalDatetime

string

Format: ISO 8601

selectedAmenities

arrayYes

selectedAmenities[]key

stringYes

Value to send in selectedAmenities.

selectedAmenities[]name

stringYes

Localized name.

selectedAmenities[]description

stringNo

selectedAmenities[]imageUrl

string

Format: URL

selectedAmenities[]pngImageUrl

string

Format: URL

selectedAmenities[]inputType

enum

booleannumeric

selectedAmenities[]included

booleanYes

True when the amenity is already part of the offer.

selectedAmenities[]selectable

booleanYes

True when the amenity can be added to this offer.

selectedAmenities[]selected

booleanYes

True when the amenity is part of the priced selection.

Response examples

json

{
  "gdsprovider": 0,
  "reservationId": "b8150702cb874abc8d592610afa2a2d9",
  "confirmationNumber": "TZ-6202191",
  "status": "completed",
  "cancelled": false,
  "totalAmount": 1462.82,
  "currency": "USD",
  "pickupInstructions": "Your driver will be waiting for you near the baggage claim with your name on a sign.",
  "departureDatetime": "2026-08-16T14:40:00-04:00",
  "arrivalDatetime": "2026-08-16T15:06:00-04:00",
  "selectedAmenities": []
}

Errors

HTTP	Code	Meaning	Recommended action
`400`		The body, query or path is invalid, or contains an unknown property.	Fix the request using the `message` array.
`400`	`transfer_invalid_currency`	The currency is outside the supported list.	Use a supported currency.
`400`	`transfer_invalid_language`	The requested language is not supported.	Use one of the documented language values.
`429`	`transfer_provider_error`	The service is temporarily rate limited.	Retry with exponential backoff.
`502`	`transfer_provider_error`	The request could not be completed.	Do not assume success. Keep your identifiers and read the reservation when the operation could have been created.
`400`	`transfer_currency_mismatch`	The currency does not match the offer, the quote or the reservation.	Reuse the currency returned by the previous step, or omit the field to inherit it.
`503`		The price could not be confirmed right now.	Retry later. Do not book and do not charge the traveller.

Usage notes

This endpoint returns only the first reservation of the result. For reservations created with amenities, read them by searchId instead so nothing is left out.

cURL example

bash

curl --request GET \
  --url "https://api.sandbox.travelandz.com/v1/transfers/reservations/b8150702cb874abc8d592610afa2a2d9?gdsprovider=0&currency=USD" \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"