Sign in

v1

latestOpenAPI 3.0.32026-07-14133451.7 KB
Booking

Create a booking check of specific trip

A CheckResponse with an unique checkId will be returned, given a Check including a list of segmentGroups and information of passengers.

The list of segmentGroups should come from a specific Trip included in a PollResponse.

An optional extended map of key:value pairs can be used to assoicate certain custom data with this particular request for future tracking.

For example, it is recommended to pass a client side order ID to this extended map, so later when a response is returned it is convenient to identify the corresponding order at client side.

post/booking/checks

Request body

checkIdstring

UUID

currencystring

3-letter currency code in ISO 4217 format

totalAmountnumber

Total price amount of all passengers for the flight, including tax and miscellaneous fees.

extendedExtended

Extended data from client side to associate. This is useful for storing some information later needs to be retrieved, such as client side order ID. The data is in form of key:value pairs. All data will be returned in response.

Example request

{
  "checkId": "23246c8e-11ad-4105-845b-07ad855649c3",
  "currency": "EUR",
  "totalAmount": 456.78,
  "segmentGroups": [
    {
      "segmentGroupId": "1feefb95-7b9e-49e4-828c-b1844dd9d9ec",
      "depDate": "20210401",
      "depAirport": "LON",
      "arrAirport": "CGN",
      "carrier": "AC",
      "retDate": "20210401",
      "segments": [
        {
          "depDate": "20210401",
          "depTime": "12:45",
          "depAirport": "LON",
          "arrDate": "20210401",
          "arrTime": "17:50",
          "arrAirport": "CGN",
          "flightNo": "AC103",
          "carrier": "AC"
        }
      ]
    }
  ],
  "passengers": [
    {
      "firstName": "Peter",
      "lastName": "Parker",
      "birthday": "2001-01-01",
      "travelDocument": {
        "number": "EG12345678",
        "placeOfIssue": "USA"
      }
    }
  ],
  "extended": {
    "clientsideOrderId": "O1234",
    "clientsideCustomField1": "A",
    "clientsideCustomField2": "B",
    "clientsideCustomField3": "C"
  }
}

Response

OK

This is a CheckResponse containing a Check with unique checkId that can be referred to when obtaining CheckStatus or in creating an Order.

messagestring

message returned by server side if there is any