Errors & codes

Response format

Success

1 {
2   "statusCode": 200,
3   "data": {},
4   "message": "Success",
5   "success": true
6 }

Error

1 {
2   "statusCode": 400,
3   "success": false,
4   "message": "Validation error.",
5   "errors": {
6     "code": "VALIDATION_ERROR",
7     "details": "..."
8   }
9 }

HTTP statuses

HTTP	Meaning
`200`	Success
`201`	Order created
`400`	Validation or business rule error
`401`	Missing or invalid `x-api-key`
`404`	Ride not found
`500`	Server error

Business codes

Code	Endpoint	Meaning
`FARE_CALCULATED`	Fare estimate	Fare quotes returned
`RIDE_CREATED`	Create order	Order created
`USER_HAVE_ACTIVE_RIDE`	Create order	Rider already has an active ride
`WEBHOOK_REQUIRED`	Create order	`webhookURL` was not provided
`VALIDATION_ERROR`	Any	Invalid request body
`RIDE_CANCELLED`	Cancel	Ride cancelled
`RIDE_NOT_FOUND`	Cancel / feedback	Unknown `orderId`
`RIDE_NOT_CANCELLABLE`	Cancel	Ride cannot be cancelled in its current state
`FEEDBACK_SUBMITTED`	Feedback	Feedback saved
`SERVER_ERROR`	Any	Unexpected failure

Active ride rule

A rider can have only one active ride at a time. Create order returns USER_HAVE_ACTIVE_RIDE when an active ride already exists.