These docs are for v1.0. Click to read the latest docs for v2.0.
added

Charged Cancellation Fees

Feb 5th 2020 - We will now send back cancellation fee details in all of our APIs!

What's New?

This release marks the next step in bringing greater transparency to the Karhoo marketplace. We are now exposing the fleets cancellation policy at the quote stage and fare state in the Bookings and Fares API.

Cancellation Policy in the Quotes and Bookings API

Cancellation Fee information can now be found in a new object: service_level_agreement

"service_level_agreements": {
    "free_cancellation": {
        "minutes": 21,
        "type": "TimeBeforePickup"
    },
    "free_waiting_time": {
        "minutes": 12
    }
}

Free Cancellation

The fleets free cancellation policy will be returned when applicable.

If the "type" is set to TimeBeforePickup then the minutes field
will contain information about the free cancellation period.
The cancellation will be free up till X minutes before the
scheduled arrival for the pre booked trips and X minutes after
making a booking for ASAP trips.

If the type is set to BeforeDriverEnRoute, then the cancellation
is free until the driver is en route to the pickup point.

Free Waiting Time

The grace period for waiting time is also available as a result of our cancellation work.

Quotes API Example

Here is an example of where you will find the new service_level_agreements object in the Retrieve Quote List response.

1162

Bookings API Example

Here is an example of where you will find the new service_level_agreements object in the Get Bookings Detail endpoint.

1160

Cancellation Fees in the Fares API

The Fares API will now return the fare details of a completed or cancelled trip during the settlement process.

{
  "breakdown": {
    "base": {
      "list_price": 2000,
      "net_price": 2000,
      "tax_amount": 400,
      "tax_percentage": 20
    },
    "currency": "GBP",
    "expenses": null,
    "extras": null,
    "total": 2400
  },
  "expected_final_time": "2021-01-05T02:12:13.000Z",
  "state": "PENDING"
}

Once the cancelled trip have finished the settlements process it will be marked as CANCELLED and charged to the appropriate accounts.

{
  "breakdown": {
    "base": {
      "list_price": 2000,
      "net_price": 2000,
      "tax_amount": 400,
      "tax_percentage": 20
    },
    "currency": "GBP",
    "expenses": null,
    "extras": null,
    "total": 2400
  },
  "state": "CANCELLED"
}

🚧

Cancelled without Fee

If the fare state is CANCELLED without any fare information or the total is zero then there is no Cancellation Fee to be charged.