API docs by Redocly

Connect API for Rental Cars (1.1.0)

Download OpenAPI specification:

ConnectAPI is a family of APIs that standardize integration between provider and user of the services. It is designed to be RESTful, using standard HTTP methods like GET, POST, and DELETE, and it primarily exchanges data in JSON format. Connect API for Rental Cars focuses specifically on the rental car services, including cars, motorbikes and campers offered by car rental suppliers (e.g. desk-at-airport, city offices, harbour or railway stations).

The API definition below is designed to handle the whole lifecycle of the rental car booking process, from searching for available rental car offers to booking and cancelling them. The key functionalities of the Connect API for Rental Cars are:

  1. Searching for Rental Cars: This endpoint lists all available rental car offers based on the input criteria (pickup/drop-off locations, travel period, driver age, ACRISS filters, etc.). Each rental car offer comes with basic information like pickup/drop-off location, vehicle category (ACRISS), included services, total price, cancellation policy, etc.

  2. Getting Rental Car Offer Details: This endpoint returns the detailed view of a previously listed rental car offer. The details include the full set of equipment, included services, conditions, pictures, and the breakdown of the total price.

  3. Checking Rental Car Availability: This endpoint extends the functionality above. In addition to providing rental car details, it also verifies the current status of the offer's availability. After the availability has been confirmed, it is expected the offer booking is ensured for a limited time, e.g. 30 minutes.

  4. Booking a Rental Car: This endpoint enables booking a specific rental car offer. It requires the offer reference, the main contact passenger details. This call returns a booking reference.

  5. Canceling a Rental Car booking: This endpoint cancels a specific rental car booking. It requires the booking reference to perform the cancellation and may return a cancellation fee.

Change History

API Version Docs Version Changes
1.0 18.05.2026 Initial version
1.1 16.06.2026 Added optional requiredDriverData field to RentalCarOffer for supplier-driven driver data requirements

Authentication

All API requests must be made over HTTPS.

Identification can be provided via either:

  • A Contract-Id header identifying the contract configuration
  • Login and Password headers for login-based authentication

The identification method should be agreed with Nezasa before integration development starts. Both methods may be provided simultaneously if required by the integration.

Heartbeat

Healthcheck endpoint

This endpoint, often known as a "health check" endpoint, is used for monitoring and assessing the status of the service. Its main function is to signal the health of the service, aiding in identifying any potential issues or service breakdowns.

TripBuilder will periodically call this endpoint to check the service's status. The response from this health check endpoint is used to assess the current condition of the service. If the service is operating correctly, the endpoint will return a positive acknowledgment, i.e. a HTTP 200 status code and a message indicating the service's health.

On the other hand, if the service is not functioning as expected, the endpoint will return an error status code and potentially additional data about the issue's nature.

This proactive health check allows for prompt detection and resolution of issues, ensuring the service's reliability and smooth functioning.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "details": [
    ],
  • "message": "message"
}

Search and Book

Get the details of a rental car offer.

Obtain the full details of a previously listed rental car offer. The response contains the same RentalCarOffer shape returned by the search call, but enriched with the supplier-specific equipment selection, included services, conditions, and pictures.

Authorizations:
ApiKeyAuth
header Parameters
traceparent
string
Example: 00-666b4b3800000000089918a4bf7e8d29-40eeac6740412d3f-01

For tracking and debugging, we will include a tracing header with every request. This trace ID follows the W3C Trace Context standard. Users can see this same header in the Trip Builder API responses and match it with data in the Supplier system if needed.

Contract-Id
string
Example: nicetours, 123456

An identifier of the contract to differentiate configuration, options or settings. This is one of two supported identification methods. Either provide a Contract-Id header, or provide Login and Password headers. Both may be provided simultaneously if required by the integration. The identification method should be agreed with Nezasa before development starts.

Login
string

Login identifier for supplier authentication. An alternative to the Contract-Id header. When using login-based authentication, both Login and Password headers should be provided. The identification method should be agreed with Nezasa before development starts.

Password
string <password>

Password for supplier authentication. Used together with the Login header as an alternative to the Contract-Id header. The identification method should be agreed with Nezasa before development starts.

Request Body schema: application/json
required
reference
required
string

The reference of the offer returned from the search call.

currency
required
string

Preferred currency. 3-letter code (ISO 4217).

lang
required
string (Supported languages)
Default: "en"
Enum: "de" "en" "fr" "it" "nl" "es" "fi" "pt" "sv" "no" "da" "pl"

2-letter code (ISO 639-1)

required
object (CommonTravelPeriod)

Generic travel period

object (RentalCarRequestLocation)

Description of a rental pickup or drop-off location. At least one of geoCircle, geoPolygon or iataCode must be provided to allow the supplier to resolve a station. When more than one is provided, suppliers should prioritise in the order:

  • iataCode
  • geoCircle
  • geoPolygon
object (RentalCarRequestLocation)

Description of a rental pickup or drop-off location. At least one of geoCircle, geoPolygon or iataCode must be provided to allow the supplier to resolve a station. When more than one is provided, suppliers should prioritise in the order:

  • iataCode
  • geoCircle
  • geoPolygon
object (AcrissDescriptionFilter)

Optional filter on offers based on the ACRISS vehicle category code. Suppliers may use the filter on a best-effort basis. Any unset field acts as a wildcard.

driverBirthDate
string

Driver's birth date in ISO 8601 format (yyyy-MM-dd). Some suppliers require this for age-based offer filtering.

required
Array of objects (Basic representation of a pax) non-empty

Passengers using the rental car.

countryCodes
required
Array of strings non-empty

2-letter (ISO 3166-1 alpha-2) codes of the countries the rental car will be driven through. Must be non-empty.

customerIp
string

IP address of the customer, when the supplier requires it.

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "reference": "reference",
  • "period": {
    },
  • "countryCodes": [
    ],
  • "metadata": {
    },
  • "customerIp": "203.0.113.42",
  • "dropoffLocation": {
    },
  • "acrissFilter": {
    },
  • "currency": "EUR",
  • "pickupLocation": {
    },
  • "lang": "en",
  • "paxes": [
    ],
  • "driverBirthDate": "1990-01-01"
}

Response samples

Content type
application/json
{
  • "offer": {
    },
  • "rawRequests": [
    ],
  • "notifications": [
    ],
  • "rawResponses": [
    ]
}

Check availability of a rental car offer

Verifies the current availability status of a specific rental car offer and prepares the offer for booking. After the availability has been confirmed, it is expected the offer booking is ensured for a limited time, e.g. 30 minutes.

Authorizations:
ApiKeyAuth
header Parameters
traceparent
string
Example: 00-666b4b3800000000089918a4bf7e8d29-40eeac6740412d3f-01

For tracking and debugging, we will include a tracing header with every request. This trace ID follows the W3C Trace Context standard. Users can see this same header in the Trip Builder API responses and match it with data in the Supplier system if needed.

Contract-Id
string
Example: nicetours, 123456

An identifier of the contract to differentiate configuration, options or settings. This is one of two supported identification methods. Either provide a Contract-Id header, or provide Login and Password headers. Both may be provided simultaneously if required by the integration. The identification method should be agreed with Nezasa before development starts.

Login
string

Login identifier for supplier authentication. An alternative to the Contract-Id header. When using login-based authentication, both Login and Password headers should be provided. The identification method should be agreed with Nezasa before development starts.

Password
string <password>

Password for supplier authentication. Used together with the Login header as an alternative to the Contract-Id header. The identification method should be agreed with Nezasa before development starts.

Request Body schema: application/json
required
reference
required
string

The offer reference returned by the search or offer-details call.

currency
required
string

Preferred currency. 3-letter code (ISO 4217).

lang
required
string (Supported languages)
Default: "en"
Enum: "de" "en" "fr" "it" "nl" "es" "fi" "pt" "sv" "no" "da" "pl"

2-letter code (ISO 639-1)

required
object (CommonTravelPeriod)

Generic travel period

required
object (Basic representation of a pax)
Array of objects (EquipmentReference)

Equipment items selected by the customer.

flightNumber
string

Flight number of the arriving flight, when the pickup is at an airport.

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "reference": "reference",
  • "period": {
    },
  • "metadata": {
    },
  • "equipment": [
    ],
  • "currency": "EUR",
  • "lang": "en",
  • "mainContactPax": {
    },
  • "flightNumber": "LX38"
}

Response samples

Content type
application/json
{
  • "offer": {
    },
  • "rawRequests": [
    ],
  • "availabilityStatus": "Available",
  • "notifications": [
    ],
  • "rawResponses": [
    ]
}

Book a rental car

Books a specific rental car offer. Uses the offer reference returned by the availability check.

Authorizations:
ApiKeyAuth
header Parameters
traceparent
string
Example: 00-666b4b3800000000089918a4bf7e8d29-40eeac6740412d3f-01

For tracking and debugging, we will include a tracing header with every request. This trace ID follows the W3C Trace Context standard. Users can see this same header in the Trip Builder API responses and match it with data in the Supplier system if needed.

Contract-Id
string
Example: nicetours, 123456

An identifier of the contract to differentiate configuration, options or settings. This is one of two supported identification methods. Either provide a Contract-Id header, or provide Login and Password headers. Both may be provided simultaneously if required by the integration. The identification method should be agreed with Nezasa before development starts.

Login
string

Login identifier for supplier authentication. An alternative to the Contract-Id header. When using login-based authentication, both Login and Password headers should be provided. The identification method should be agreed with Nezasa before development starts.

Password
string <password>

Password for supplier authentication. Used together with the Login header as an alternative to the Contract-Id header. The identification method should be agreed with Nezasa before development starts.

Request Body schema: application/json
required
reference
required
string

The reference of the quote returned by the availability call.

currency
required
string

Preferred currency. 3-letter code (ISO 4217).

lang
required
string (Supported languages)
Default: "en"
Enum: "de" "en" "fr" "it" "nl" "es" "fi" "pt" "sv" "no" "da" "pl"

2-letter code (ISO 639-1)

required
object (CommonTravelPeriod)

Generic travel period

required
object (Basic representation of a pax)
Array of objects (EquipmentReference)

Equipment items selected by the customer.

flightNumber
string

Flight number of the arriving flight, when the pickup is at an airport.

object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "reference": "reference",
  • "period": {
    },
  • "metadata": {
    },
  • "equipment": [
    ],
  • "currency": "EUR",
  • "lang": "en",
  • "mainContactPax": {
    },
  • "flightNumber": "LX38"
}

Response samples

Content type
application/json
{
  • "booking": {},
  • "rawRequests": [
    ],
  • "notifications": [
    ],
  • "rawResponses": [
    ]
}

Post Booking

Cancel a rental car booking

Cancels a specific rental car booking. Returns the cancellation fee, if any, as charged by the supplier.

Authorizations:
ApiKeyAuth
header Parameters
traceparent
string
Example: 00-666b4b3800000000089918a4bf7e8d29-40eeac6740412d3f-01

For tracking and debugging, we will include a tracing header with every request. This trace ID follows the W3C Trace Context standard. Users can see this same header in the Trip Builder API responses and match it with data in the Supplier system if needed.

Contract-Id
string
Example: nicetours, 123456

An identifier of the contract to differentiate configuration, options or settings. This is one of two supported identification methods. Either provide a Contract-Id header, or provide Login and Password headers. Both may be provided simultaneously if required by the integration. The identification method should be agreed with Nezasa before development starts.

Login
string

Login identifier for supplier authentication. An alternative to the Contract-Id header. When using login-based authentication, both Login and Password headers should be provided. The identification method should be agreed with Nezasa before development starts.

Password
string <password>

Password for supplier authentication. Used together with the Login header as an alternative to the Contract-Id header. The identification method should be agreed with Nezasa before development starts.

Request Body schema: application/json
required
bookingReference
required
string

The bookingReference of the booking to be cancelled.

reference
string

Optional offer reference. Some suppliers require it in addition to the bookingReference to perform the cancellation.

object (CommonTravelPeriod)

Generic travel period

object (Basic representation of a pax)
object (Metadata)

Responses

Request samples

Content type
application/json
{
  • "reference": "reference",
  • "bookingReference": "BOOKING-123456",
  • "period": {
    },
  • "metadata": {
    },
  • "mainContactPax": {
    }
}

Response samples

Content type
application/json
{
  • "bookingReference": "BOOKING-123456",
  • "rawRequests": [
    ],
  • "cancellationFee": {
    },
  • "notifications": [
    ],
  • "rawResponses": [
    ]
}