Skip to content

Decline offer

POST/offers/{id}/decline

Auth: X-API-Key headerhttps://warpdrive.staging.transferz.com/transfercompanies

Declines an available offer

Declines an offer with a reason, so Transferz can offer the journey to another company and improve future offers. Some reasons, such as OTHER, need a description.

Guides: Accept or decline offers, Constants

Path parameters

  • idinteger · int64required

    The id of the offer to decline

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Request body

application/json

  • reasonenumrequired

    Why you decline.

    FARE_TOO_LOW
    The offered fare is too low.
    NO_VEHICLE_AVAILABILITY
    No vehicle is available at that time.
    NO_DRIVER_AVAILABILITY
    No driver is available at that time.
    ADDONS_NOT_AVAILABLE
    One or more requested add-ons cannot be provided.
    INCORRECT_JOURNEY_DETAILS
    The journey details look wrong.
    HOLIDAY
    Closed for a holiday.
  • descriptionstring

    Explanation; needed for some reasons such as OTHER.

Responses

No content

Errors this endpoint can return

  • 400, failedOFFER_FINALIZED

    When: The offer was already accepted, expired or missed.

    What to do: Check the offer status with Get offer before responding.

  • When: The reason needs a description.

    What to do: Add a short description.

Was this helpful?