Rimo Global Transfers API

Authentication

API access is available to contracted Rimo Global partners. During onboarding we issue your API token, whitelist your servers' static public IP addresses, and give you your base URL. Send the token in the Authorization header of every request.

POST <base-url>/api/transferservices/TransferList
Authorization: Bearer <your token>
Content-Type: application/json
Accept: application/json

Booking flow

Every transfer booking follows the same sequence. Each response carries the keys the next call needs.

1. 1SearchVehicle offers + pricessearchKey · uniqueKey
2. 2OptionsRequired fields + extrasper vehicle
3. 3QuoteCart + price checkbookingToken
4. 4BookCreates the bookingreferenceNo
5. 5VerifyRead back the bookingalways

To cancel: Cancellation detail → CancelBooking → read BookingDetails again; the cancel is done only when the status shows Cancelled.

Rules for every request

• POST with a JSON body (except the two read calls, which are GET).
• Use keys fresh. searchKey and uniqueKey are short-lived; always search again before quoting and booking.
• Prices are the total for the transfer in your account currency.
• Refundable fares are recommended for resale; always read the cancellation policy returned at quote.
• Errors come back with a status and a message. Check every response, even on HTTP 200.
• Never retry Book blindly after a timeout — read the booking back with its reference instead (see Cancel & verify for the same principle).

Booking flow

1 · Search

One row per vehicle offer for a route and date. fromType/toType: A airport, H hotel. Place ids are Google Place IDs. departureDate must be today or later.

Request

{
  "fromLatitude": 30.1095011, "fromLongitude": 31.389179,
  "toLatitude": 30.0352247, "toLongitude": 31.2137474,
  "departureDate": "2027-01-19T19:00:00", "departureTime": "19:00:00",
  "fromType": "A", "toType": "H",
  "fromPlaceId": "ChIJUdjd5XEXWBQRBeLwBHq31Bg",
  "toPlaceId": "ChIJcyOeoGJAWBQRjA64QUTDT04",
  "fromLocationName": "Cairo Airport", "toLocationName": "Safir Hotel Cairo",
  "isRoundTrip": 0, "luggageCapacity": 3, "passengers": 1,
  "transferRateTypes": [
    { "transferRateTypeId": 1, "count": 1, "transferRateTypeName": "Adult" }
  ]
}

Response

{
  "result": [
    {
      "vehicleName": "Economy Sedan", "vehicleType": "Sedan",
      "transferType": "Private", "capacity": 3, "luggageCapacity": 3,
      "distanceKM": 22.4, "estimatedTime": "35 min",
      "totalPrice": 12.12, "currencyCode": "USD",
      "policyName": "Refundable",
      "searchKey": "…", "uniqueKey": "…"
    }
  ]
}

Booking flow

2 · Options

Before quoting, read the per-vehicle passenger fields, available extras and cancellation windows for a uniqueKey.

Required and optional passenger fields (for example Flight Number, Driver Comments). Fill every required field in the quote.

Available extras for the vehicle (for example Meet & Greet, usually free). Add the ones your customer chooses to the quote.

The cancellation windows and charges for the vehicle on the travel date.

{ "uniqueKey": "<from search>", "lang": "en" }

Booking flow

3 · Quote

Carry the offer, lead passenger, required fields and extras to a firm price and a bookingToken. Three calls:

PriceCheck response (shape)

{
  "result": {
    "bookingToken": "…",
    "sellingPrice": 12.12,
    "cancellationPolicy": [ … ],
    "priceHike": false
  }
}

Booking flow

4 · Book

Books against your credit limit and creates a real supplier booking; the confirmation and voucher are issued. Use the bookingToken from the quote. Send a real lead passenger name in Latin letters.

Response (shape)

{
  "result": {
    "code": 1,
    "referenceNo": "<base64 reference>",
    "bookingId": 431, "detailId": 443,
    "bookingStatus": "Vouchered",
    "supplierConfirmationNo": "69214771"
  }
}

After booking

Read a booking

Returns the current status, supplier confirmation, amount, pickup / drop-off and cancellation policy. Use it after every Book, and whenever you need the live status.

After booking

Cancel & verify

Cancellation is two calls plus a mandatory read-back.

Preview the refund before cancelling (booking amount, charge, refund).

Sends the cancellation.

GET /api/Booking/BookingDetails/{referenceNo}
→ bookingStatus == "Cancelled"   // this, not the CancelBooking HTTP code, is the proof

Postman collection

The full flow as a ready-to-run Postman collection — search, options, quote, book, read, and cancel with the verify step. Set your base URL and token as collection variables.

Download the Postman collection

Certification checklist

Tick these before go-live. Your ticks are saved in this browser only.

Partner support

Questions, a token, or a base URL: api@rimoglobal.com. For the hotels API, see the Rimo Global Hotels API.