Overview
This API collection provides a comprehensive suite of endpoints designed to facilitate seamless cab booking, ride management, and real-time driver tracking. These APIs enable developers to integrate robust transportation functionalities into their applications, offering users a streamlined experience for requesting and managing cab services.
Core Functionalities:
- Cab Booking
- Ride Management
- Driver Tracking
Common Request Headers:
- correlationId (String, Required): Unique ID for tracing requests.
- Authorization (String, Required): Bearer token for authentication.
- Content-Type (String, Required): Must be application/json.
Login
▶Endpoint:
/auth/v1/login
Method: POST
Idempotent: No
Description: Authenticates a user and returns a JWT (JSON Web Token) for subsequent API requests.
Validation:
- username (String, Required)
- password (String, Required)
Sample cURL Request:
curl --location '{{baseUrl}}/auth/v1/login' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"username": "username",
"password": "password"
}'Request Example:
{ "username": "xyz", "password": "xyz1234" }
Response Example:
{ "message": "Login successful", "code": 200, "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expiresAt": 1746216087463 }
- message (String) - A success message indicating the login was successful.
- code (Number) - HTTP status code representing the result of the operation (200 = success).
- token (String) - JWT token to be used for authenticated requests.
- expiresAt (Number) - Expiry timestamp (in milliseconds since epoch) for the token validity.
Error Responses:
{ "message": "Invalid credentials", "code": 401 }
{ "message": "\"username\" is required", "code": 400 }
{ "message": "\"password\" is required", "code": 400 }
{ "status": "failure", "message": "Internal server error", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
City List
▶Endpoint:
/api/v1/booking/cityList
Method: GET
Idempotent: YES
Description: Fetches a list of pickup points (airports and terminals) based on the search query, suported by mojoboxx.
Validation:
- latitude (Number, optional): Latitude for filtering nearby pickup points.
- longitude (Number, optional): Longitude for filtering nearby pickup points.
Sample cURL Request:
curl --location '{{baseUrl}}/api/v1/booking/cityList?latitude=28.5627225&longitude=77.1171405' \
--header 'correlationId: 6731c8eb-8509-49b8-b526-8184f8c917b3' \
--header 'Authorization: ••••••' \
--data ''Request Example:
/api/v1/booking/cityList?latitude=28.5627225&longitude=77.1171405
Response Example:
{ "status": "success", "message": "Pickup points fetched successfully", "code": 200, "data": [ { "id": 26, "airportCode": "DEL", "terminalId": "T1", "sourceName": "IGI Airport-T1", "sourceCity": "Delhi", "sourceLatitude": "28.5627225", "sourceLongitude": "77.1171405", "sourceAddress": "IGI Airport-T1", "airportName": "Indira Gandhi International Airport (DEL)", "fuzzyList": "Red Fort, Qutub Minar, India Gate, Jama Masjid, Lotus Temple, Akshardham Temple, Humayun Tomb, Raj Ghat, Jantar Mantar, Chandni Chowk, Noida, Ghaziabad, Terminal 1, Terminal 2, Terminal 3, Terminal, Lal quila, Dilli, Delhi, Indira Gandhi International Airport, Greater Noida, Gurugram, Gurgaon, New Delhi, DEL, Aerocity, Delhi Airport", "displaySourceName": "T1 , IGI Airport-T1 , Delhi", "distanceInKm": 0.0002 }, { "id": 27, "airportCode": "DEL", "terminalId": "T2", "sourceName": "IGI Airport-T2", "sourceCity": "Delhi", "sourceLatitude": "28.5584867", "sourceLongitude": "77.0872235", "sourceAddress": "IGI Airport-T2", "airportName": "Indira Gandhi International Airport (DEL)", "fuzzyList": "Red Fort, Qutub Minar, India Gate, Jama Masjid, Lotus Temple, Akshardham Temple, Humayun Tomb, Raj Ghat, Jantar Mantar, Chandni Chowk, Noida, Ghaziabad, Terminal 1, Terminal 2, Terminal 3, Terminal, Lal quila, Dilli, Delhi, Indira Gandhi International Airport, Greater Noida, Gurugram, Gurgaon, New Delhi, DEL, Aerocity, Delhi Airport", "displaySourceName": "T2 , IGI Airport-T2 , Delhi", "distanceInKm": 2.9606 }, { "id": 28, "airportCode": "DEL", "terminalId": "T3", "sourceName": "IGI Airport-T3", "sourceCity": "Delhi", "sourceLatitude": "28.5550838", "sourceLongitude": "77.0818266", "sourceAddress": "IGI Airport-T3", "airportName": "Indira Gandhi International Airport (DEL)", "fuzzyList": "Red Fort, Qutub Minar, India Gate, Jama Masjid, Lotus Temple, Akshardham Temple, Humayun Tomb, Raj Ghat, Jantar Mantar, Chandni Chowk, Noida, Ghaziabad, Terminal 1, Terminal 2, Terminal 3, Terminal, Lal quila, Dilli, Delhi, Indira Gandhi International Airport, Greater Noida, Gurugram, Gurgaon, New Delhi, DEL, Aerocity, Delhi Airport", "displaySourceName": "T3 , IGI Airport-T3 , Delhi", "distanceInKm": 3.5532 } ], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
- status (String) - Indicates the status of the response (e.g., "success").
- message (String) - A message describing the result of the API call.
- code (Number) - HTTP status code representing the result (200 = success).
- data (Array) - List of pickup points. Each object in the array contains:
- id (Number) - Unique identifier for the pickup point.
- airportCode (String) - Code of the airport (e.g., "DEL").
- terminalId (String) - Identifier for the terminal (e.g., "T1").
- sourceName (String) - Name of the pickup location.
- sourceCity (String) - City where the pickup point is located.
- sourceLatitude (String) - Latitude of the pickup location.
- sourceLongitude (String) - Longitude of the pickup location.
- sourceAddress (String) - Address of the pickup location.
- airportName (String) - Name of the airport.
- fuzzyList (String) - List of fuzzy matches.
Error Responses:
{ "status": "failure", "message": "Access denied. No token provided.", "code": 401 }
{ "status": "failure", "message": "Internal server error'", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
Fare Search
▶Endpoint:
/api/v1/booking/fareSearch
Method: POST
Idempotent: No
Description: Search for available cab fares based on source and destination.
Validation:
- sourceName (String, Required): Name of the source location.
- sourceLatitude (Float, Required): Latitude of the source location.
- sourceLongitude (Float, Required): Longitude of the source location.
- sourceCity (String, Required): City of the source location.
- destinationName (String, Required): Name of the destination location.
- destinationLatitude (Float, Required): Latitude of the destination location.
- destinationLongitude (Float, Required): Longitude of the destination location.
- destinationCity (String, Required): City of the destination location.
- startDatetime (String, Required): Start time of the ride in ISO 8601 format.
- cityCode (String, Required): City code (e.g., DEL for Delhi). (airportCode from /cityList object)
- travelType (String, Required): Type of travel (e.g., Departure or Arrival).
- kilometer (String, Required): Distance between source and destination
- duration (String, Required): Time duraion in minute of travel.
Sample cURL Request:
curl --location '{{baseUrl}}/api/v1/booking/fareSearch' \
--header 'correlationId: 6731c8eb-8509-49b8-b526-8184f8c917b3' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--header 'Cookie: connect.sid=s%3AMeJ4ENxUdNkFaWVGsxkXVs1-7I7tQJWc.FsL7nl%2B7j8EVzsBx%2Fj5drPOyqBd6mu6JRxbLKkYKgPk' \
--data '{
"sourceName": "Mahipalpur, New Delhi, Delhi, India",
"sourceLatitude": 28.5448686,
"sourceLongitude": 77.1281345,
"sourceCity": "Delhi",
"destinationName": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India",
"destinationLatitude": 28.5550838,
"destinationLongitude": 77.0818266,
"destinationCity": "Delhi",
"startDatetime": "2026-05-02T02:00:00.000Z",
"cityCode": "DEL",
"travelType": "departure",
"kilometer": 8.2,
"duration": 19,
"sourceAddress": "Mahipalpur, New Delhi, Delhi, India",
"destinationAddress": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India",
"sourceState": "Delhi",
"destinationState": "Delhi"
}'Request Example:
{ "sourceName": "Mahipalpur, New Delhi, Delhi, India", "sourceLatitude": 28.5448686, "sourceLongitude": 77.1281345, "sourceCity": "Delhi", "destinationName": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India", "destinationLatitude": 28.5550838, "destinationLongitude": 77.0818266, "destinationCity": "Delhi", "startDatetime": "2026-05-02T02:00:00.000Z", "cityCode": "DEL", "travelType": "departure", "kilometer": 8.2, "duration": 19, "sourceAddress": "Mahipalpur, New Delhi, Delhi, India", "destinationAddress": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India", "sourceState": "Delhi", "destinationState": "Delhi" }
Response Example:
{ "status": "success", "message": "Fare fetched successfully", "code": 200, "data": [ { "journeyType": "AIRPORT", "airConditioned": true, "title": "Carzonrent", "cabPartner": "CARZONRENT", "image": "https://cdn.bookairportcab.com/svglogos/logo_carzonrent_84x84.svg", "imageApp": "https://cdn.bookairportcab.com/svglogos/logo_carzonrent_84x84.svg", "imageMobile": "https://cdn.bookairportcab.com/svglogos/logo_carzonrent38x38.svg", "model": "Dzire or Similar", "makeYear": 2016, "seats": "2", "subcategory": "Economy", "vehicleType": "Sedan", "cabId": "ed401ba7-2c6c-469f-b06b-95a9b394d794", "fareId": "Unknown", "searchId": "0721db32-e7ca-4c06-8f36-0e7dd3fe3df5|ae4c2694a186467591ea1f41117a10f727e52d4763089bc59dc0f6e42c5887d4", "features": { "freeCancellationTill": 30, "extraKmFare": 24, "fuelType": "CNG" }, "featuresDisplayMap": { "Extra Km fare": "INR 24/Km", "Fuel Type": "Cng", "Free Cancellation": "Till pickup time" }, "expiryTime": 1778042894530, "tag": "No Recommendation", "fare": 229.97, "maxFare": "264", "baseFare": 219, "tollCharges": 0, "tax": 10.97, "serviceCharge": 0, "kilometer": 8.2, "duration": 19, "inclusion": [ "8.2 Kms Ride", "GST Included ₹10.97" ], "exclusion": [ "Toll Charges", "Waiting Charges (after 20 mins) ₹100/30 mins", "Extra Km Fare (₹24/Km)", "Airport parking charges may apply as per destination airport rules.", "Toll charges(if applicable and not included in fare) are payable against a valid receipt.", "If no receipt is provided for any extra charge, contact care@bookairportcab.com for assistance" ], "extraDetails": { "totalFare": 229.97, "rideFare": 219, "gstOnRideFare": 10.97, "serviceFees": null, "gstOnServiceFees": null, "tollChargesIncluded": false, "tollCharges": 0, "interStateTaxesIncluded": false, "interStateCharges": 0, "parkingCharges": 0, "driverBata": 0, "nightCharges": 0, "additionalCharges": null, "extraKmFare": 24, "extraHourFare": null, "seatCapacity": "2", "luggageCapacity": "2", "airportEntryFeeAmount": 0, "vehicleSubcategory": "basic", "carrier": false, "make_year_type": "Unknown", "cancellation_rule": "FLEXI", "fuelType": "CNG" }, "loyaltyPoints": 11, "rawFareData": { "Base Fare": 219, "Tax": 10.97, "Total Fare": 229.97 }, "fareDisplay": { "Base Fare": "₹ 219", "Tax": "₹ 10.97", "Total Fare": "₹ 229.97" }, "applicableCoupons": [], "travelType": "departure", "cityCode": "DEL", "filterTag": "Sedan", "rating": 4.6, "ratingCount": 353, "partial": null, "cash": null, "full": 229.97, "fuelType": "CNG", "maxFareRaw": 264.4655, "fareDisplayStr": { "Base Fare": "₹ 219", "Tax": "₹ 10.97", "Total Fare": "₹ 229.97" }, "serializedFareDisplay": [ { "label": "Base Fare", "value": "₹ 219", "key": "baseFare" }, { "label": "Tax", "value": "₹ 10.97", "key": "tax" }, { "label": "Total Fare", "value": "₹ 229.97", "key": "totalFare" } ], "cabUSP": { "type": "3", "text": "Premium Airport Transfer" } } ], "correlationId": "17b03b3d-76e2-40f9-8c5e-9efcfd783eb8" }
-
status: Status of the API response.
- Possible values:
success,failure.
- Possible values:
- message: Descriptive message returned by the API.
- code: HTTP status code returned by the API.
-
data: Array containing available cab options.
-
journeyType: Type of booking journey.
- Example:
AIRPORT.
- Example:
-
airConditioned: Indicates whether the cab is air-conditioned.
- Possible values:
true,false.
- Possible values:
- title: Display name of the cab partner/service.
-
cabPartner: Unique identifier of the cab partner.
- Examples:
CARZONRENT,QUICKRIDE,GOZOCABS,SIGNATURE
- Examples:
- image: Desktop logo/image URL of the partner.
- imageApp: App-specific image/logo URL.
- imageMobile: Mobile-optimized image/logo URL.
- model: Vehicle model/category.
- makeYear: Manufacturing year of the vehicle.
- seats: Passenger seating capacity.
-
subcategory: Vehicle pricing category.
- Examples:
Economy,Premium
- Examples:
-
vehicleType: Type of vehicle.
- Examples:
Sedan,SUV,Hatchback
- Examples:
- cabId: Unique identifier for the cab option.
- fareId: Unique identifier for fare details.
- searchId: Unique identifier generated during fare search.
-
features: Additional cab-related features.
- freeCancellationTill: Free cancellation window in minutes.
- extraKmFare: Charge per extra kilometer.
-
fuelType: Fuel used by the vehicle.
- Possible values:
PETROL,DIESEL,CNG,ELECTRIC
- Possible values:
- featuresDisplayMap: Human-readable feature display values.
- expiryTime: Fare expiry timestamp in milliseconds.
-
tag: Recommendation or promotional label.
- Examples:
Recommended,Sponsored,No Recommendation
- Examples:
- fare: Final payable fare amount.
- maxFare: Maximum possible fare including dynamic pricing buffer.
- baseFare: Base ride fare before taxes and additional charges.
- tollCharges: Toll amount applicable for the ride.
- tax: Total tax amount applied on the booking.
- serviceCharge: Convenience/service fee charged.
- kilometer: Estimated trip distance in kilometers.
- duration: Estimated trip duration in minutes.
- inclusion: List of fare inclusions.
- exclusion: List of fare exclusions and additional payable items.
-
extraDetails: Detailed fare breakup.
- totalFare: Total payable amount.
- rideFare: Ride fare excluding taxes.
- gstOnRideFare: GST charged on ride fare.
- serviceFees: Additional service fee.
- gstOnServiceFees: GST on service fee.
- tollChargesIncluded: Indicates if tolls are included.
- tollCharges: Applicable toll amount.
- interStateTaxesIncluded: Indicates if interstate taxes are included.
- interStateCharges: Interstate charges if applicable.
- parkingCharges: Parking charges during the trip.
- driverBata: Driver allowance amount.
- nightCharges: Night-time surcharge.
- additionalCharges: Any miscellaneous extra charges.
- extraKmFare: Extra distance fare per km.
- extraHourFare: Additional hourly charge.
- seatCapacity: Passenger seating capacity.
- luggageCapacity: Luggage carrying capacity.
- airportEntryFeeAmount: Airport entry charges.
- vehicleSubcategory: Internal vehicle subcategory.
- carrier: Indicates if luggage carrier is available.
- make_year_type: Vehicle manufacturing category/type.
- cancellation_rule: Cancellation policy type.
- fuelType: Vehicle fuel type.
- loyaltyPoints: Reward/loyalty points earned on booking.
- rawFareData: Raw numeric fare breakup.
- fareDisplay: Formatted fare breakup for UI display.
- applicableCoupons: List of applicable coupons/promotions.
-
travelType: Type of airport transfer.
- Examples:
departure,arrival
- Examples:
- cityCode: Airport/city code.
- filterTag: Vehicle filter category shown in UI.
- rating: Average customer rating.
- ratingCount: Total number of ratings received.
- partial: Partial payment amount if applicable.
- cash: Cash payable amount if applicable.
- full: Full payment amount.
- fuelType: Fuel type of the cab.
- maxFareRaw: Raw maximum fare value before formatting.
- fareDisplayStr: Formatted fare display object.
- serializedFareDisplay: Serialized fare breakdown for frontend rendering.
-
cabUSP: Unique selling proposition of the cab/service.
- type: USP type identifier.
- text: USP display text.
-
journeyType: Type of booking journey.
- correlationId: Unique identifier used for request tracing and debugging.
Error Responses:
{ "status": "failure", "message": "Invalid request parameters: \"sourceName\" is required", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Invalid request parameters: startDatetime must be at least 30 minutes ahead of the current time (IST)", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Access denied. No token provided.", "code": 401 }
{ "status": "failure", "message": "Internal server error'", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
Prebook
▶Endpoint:
/api/v1/booking/prebook
Method: POST
Idempotent: Yes
Description: Locks the fare for a specific cab and returns a unique booking ID.
Validation:
- userName (String, Required): User's full name.
-
mobile (String, Required): User's mobile number.
- Must be a valid 10-digit number.
- If prefixed with '+91', the '+91' should be removed.
-
email (String, Required): User's email address.
- Must be a valid email format (e.g., user@example.com).
-
membershipId (Number, Optional): User's membership ID.
- Must be a valid number if provided.
- searchId (String, Required): Unique search ID for the booking (from fareSerach Result).
-
otherDetails (String, Optional): Additional details about the booking.
- Can be an empty string if no additional details are provided.
Sample cURL Request:
curl --location '{{baseUrl}}/api/v1/booking/prebook' \
--header 'correlationId: 6731c8eb-8509-49b8-b526-8184f8c917b3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ********' \
--header 'Cookie: connect.sid=s%3AMeJ4ENxUdNkFaWVGsxkXVs1-7I7tQJWc.FsL7nl%2B7j8EVzsBx%2Fj5drPOyqBd6mu6JRxbLKkYKgPk' \
--data-raw '{
"userName": "customer name",
"mobile": "9999999999",
"email": "abc@mojoboxx.com",
"searchId": "07a2eca8-f2e2-4bb3-907a-a4e9ce33a137|d350c3e229ba033635c7d6763b984e098ae414cc2baf32e5c1b85ffac40124d2",
"otherDetails": "Please be on time",
"returnUrl": "https://shope.me",
"merchantUrl": "https://shope.me",
"whatsappConsent": false,
"deviceType": "AN",
"consentMojoboxxTnC": true,
"paymentMode": "cash"
}'Request Example:
{ "userName": "customer name", "mobile": "9999999999", "email": "abc@mojoboxx.com", "searchId": "07a2eca8-f2e2-4bb3-907a-a4e9ce33a137|d350c3e229ba033635c7d6763b984e098ae414cc2baf32e5c1b85ffac40124d2", "otherDetails": "Please be on time", "returnUrl": "https://shope.me", "merchantUrl": "https://shope.me", "whatsappConsent": false, "deviceType": "AN", "consentMojoboxxTnC": true, "paymentMode": "cash" }
Response Example:
{
"message": "Request processed successfully",
"code": 200,
"data": {
"order_id": "JCRAN060526095314FGUT",
"redirect": false
},
"correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3"
}
{
"status": "success",
"message": "Payment link created successfully",
"code": 200,
"data": {
"accept_partial": false,
"amount": 33000,
"amount_paid": 0,
"callback_method": "get",
"callback_url": "https://shope.me?razorPayReturnId=d40573a0-4c65-49dc-9d93-65239abe81fe",
"cancelled_at": 0,
"created_at": 1778041591,
"currency": "INR",
"customer": {
"contact": "7879692393",
"email": "abc@mojoboxx.com",
"name": "customer name"
},
"description": "Payment for Order",
"expire_by": 1778045191,
"expired_at": 0,
"first_min_partial_amount": 0,
"id": "plink_SlwiXcdEXsN2kR",
"notes": null,
"notify": {
"email": true,
"sms": true,
"whatsapp": false
},
"payments": null,
"reference_id": "",
"reminder_enable": true,
"reminders": [],
"short_url": "https://rzp.io/rzp/6IeaV3ti",
"status": "created",
"updated_at": 1778041591,
"upi_link": false,
"user_id": "",
"whatsapp_link": false,
"bookingId": "JCRAN060526095401LCXB"
},
"correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3"
}
- message: Descriptive message returned by the API.
-
status: Indicates the status of the response.
- Possible values:
success,failure
- Possible values:
-
code: HTTP status code returned by the API.
- Example:
200= Request processed successfully.
- Example:
-
data: Contains payment and booking related information.
- order_id: Unique identifier generated for the booking/order.
-
redirect: Indicates whether frontend redirection is required.
- Possible values:
true,false
- Possible values:
- accept_partial: Indicates whether partial payment is allowed.
-
amount: Total payable amount in paise.
- Example:
33000= ₹330.00
- Example:
- amount_paid: Amount already paid against the payment link.
- callback_method: HTTP method used for callback redirection.
- callback_url: URL where the customer is redirected after payment completion.
-
cancelled_at: Timestamp when the payment link was cancelled.
0indicates not cancelled.
- created_at: Unix timestamp when the payment link was created.
-
currency: Currency code used for payment.
- Example:
INR
- Example:
-
customer: Customer information object.
- contact: Customer mobile number.
- email: Customer email address.
- name: Customer full name.
- description: Description associated with the payment request.
- expire_by: Unix timestamp after which the payment link expires.
-
expired_at: Timestamp when the payment link expired.
0indicates not expired.
- first_min_partial_amount: Minimum amount required for first partial payment.
- id: Unique Razorpay payment link identifier.
- notes: Additional metadata or notes attached to the payment link.
-
notify: Notification preferences for payment link communication.
- email: Send notification through email.
- sms: Send notification through SMS.
- whatsapp: Send notification through WhatsApp.
- payments: Payment transaction details linked to the payment request.
- reference_id: External reference ID associated with the payment.
- reminder_enable: Indicates whether payment reminders are enabled.
- reminders: List of reminders triggered for the payment link.
- short_url: Shortened payment URL shared with the customer.
-
status: Current status of the payment link.
- Possible values:
created,paid,expired,cancelled
- Possible values:
- updated_at: Unix timestamp when the payment link was last updated.
- upi_link: Indicates whether the payment link supports UPI intent flow.
- user_id: Internal user identifier associated with the payment link.
- whatsapp_link: Indicates whether a WhatsApp payment link was generated.
- bookingId: Unique booking identifier generated after successful pre-booking/payment link creation.
- correlationId: Unique identifier used for request tracing and debugging.
Error Responses:
{ "status": "failure", "message": "No fare data found in cache", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Invalid request parameters: \"userName\" is required", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Access denied. No token provided.", "code": 401 }
{ "status": "failure", "message": "Internal server error'", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
Payment Confirmation
▶Endpoint:
/api/v1/booking/paymentConfirmation
Method: POST
Idempotent: No
Description: Locks the fare for a specific cab and returns a unique booking ID.
Validation:
- bookingId (String, Required):Unique ID of the booking for which the payment is being confirmed.
Sample cURL Request:
curl --location '{{baseUrl}}/api/v1/booking/paymentConfirmation' \
--header 'correlationId: 6731c8eb-8509-49b8-b526-8184f8c917b3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer *********************' \
--data '{
"bookingId": "JCRWE050520175319U3KS",
"amount" : 382,
"paymentRefId": "TXN277378648"
}'
Request Example:
{ "bookingId": "JCRWE050520175319U3KS", "amount" : 382, "paymentRefId": "TXN277378648" }
Response Example:
{ "status": "success", "message": "Payment confirmed successfully", "code": 200, "data": { "transactionId": "TXN1348978984", "bookingId": "JCRWE030520013443NFPR" }, "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
- status (String) - Indicates the status of the response (e.g., "success").
- message (String) - A message describing the result of the API call.
- code (Number) - HTTP status code representing the result (200 = success).
- data (Object) - Contains payment confirmation details:
- transactionId (String) - Unique identifier for the confirmed transaction.
- bookingId (String) - Unique identifier of the associated booking.
- correlationId (String) - Unique identifier used for tracking/logging the request-response cycle.
Error Responses:
{ "status": "failure", "message": "Booking ID does not exist.", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Invalid request parameters: \"bookingId\" is required", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Access denied. No token provided.", "code": 401 }
{ "status": "failure", "message": "Internal server error'", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "PayType FULL | PaidAmount 1037.00 | RemainingAmount 0.00", "code": 409, "data": { "transactionId": "TXN5128052713", "bookingId": "JCRWE0605201447131KYR" }, "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
Booking Details
▶Endpoint:
/api/v1/booking/bookingDetails
Method: POST
Idempotent: YES
Description: Fetch booking details by booking ID.
Validation:
- bookingId (String, Required):Unique ID of the booking for which you want to see details.
Sample cURL Request:
curl --location '{{baseUrl}}/api/v1/booking/bookingDetails' \
--header 'correlationId: 6731c8eb-8509-49b8-b526-8184f8c917b3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NDYsInVzZXJuYW1lIjoib3BlcmF0aW9ucyIsInBhcnRuZXJfbmFtZSI6ImRlZmF1bHQiLCJjbGllbnRfaWQiOiJJTkciLCJwYXJ0bmVyX3R5cGUiOiJPUFNfQUdFTlQiLCJjYWJfcGFydG5lcl9uYW1lIjpudWxsLCJpYXQiOjE3NzgwNDE3MzIsImV4cCI6MTc3ODA3NzczMn0.sNZFG_ij1qYXROx-WUFKiVSsMxI6DmTCntpu_xmR7gM'
\
--data '{
"bookingId": "JCRAN060526095401LCXB"
}'
Request Example:
/api/v1/booking/bookingDetails
Response Example:
{
"status": "success",
"message": "Booking fetched successfully",
"code": 200,
"data": [
{
"bookingId": "JCRAN060526095401LCXB",
"parentBookingId": "JCRAN060526095401LCXB",
"userName": "customer name",
"mobile": "9999999999",
"email": "abc@mojoboxx.com",
"gender": null,
"image": "https://cdn.bookairportcab.com/June-30-2025/BAC-84.png",
"imageMobile": "https://cdn.bookairportcab.com/June-30-2025/BAC-38.png",
"imageApp": "https://cdn.bookairportcab.com/June-30-2025/BAC-84.png",
"pickupTime": "2026-05-08T02:00:00.000Z",
"dropOffTime": "2026-05-08T02:19:00.000Z",
"cabPartner": "SIGNATURE",
"referenceNumber": "93659ace-0d8a-417d-9b0d-673db39f9f53",
"bookingTime": "2026-05-06 09:54:01",
"sourceName": "Mahipalpur, New Delhi, Delhi, India",
"sourceLatitude": "28.5448686000",
"sourceLongitude": "77.1281345000",
"destinationName": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India",
"destinationLatitude": "28.5550838000",
"destinationLongitude": "77.0818266000",
"cityCode": "DEL",
"kilometer": 8.2,
"totalFare": 330,
"couponCode": null,
"discountApplied": 0,
"paidAmount": 0,
"remainingAmount": 330,
"paymentStatus": "Unpaid",
"tripProgress": 0,
"payType": "",
"paymentMethod": null,
"travelType": "departure",
"otherDetails": "Please be on time",
"cabAssigned": 0,
"cabLeftForPickup": 0,
"cabReachedSource": 0,
"cabTripStarted": 0,
"cabTripEnd": 0,
"features": {
"freeCancellationTill": 30,
"extraKmFare": 25,
"fuelType": "Cng"
},
"driverName": null,
"driverMobile": null,
"vehicleNumber": null,
"otp": null,
"vehicleType": "Sedan",
"fuelType": "Cng",
"seats": 2,
"airConditioned": 1,
"extraPerKm": 25,
"inclusion": [
"8.2 Kms Ride",
"GST: INR 16"
],
"exclusion": [
"Extra Km Fare: INR 25/Km",
"Waiting Charges (after 30 mins) 100/30 mins",
"Airport parking charges may apply as per destination airport rules.",
"Toll charges(if applicable and not included in fare) are payable against a valid receipt.",
"If no receipt is provided for any extra charge, contact care@bookairportcab.com for assistance"
],
"fareDetails": {
"baseFare": 314,
"tax": 16,
"tollCharges": 0,
"serviceCharge": 0
},
"status": "PREBOOK",
"isBooked": 0,
"supportEmail": "care@bookairportcab.com",
"supportContact": "+918046800969",
"cabPartnerResponse": null,
"cancellationCharge": 0,
"refundAmount": 0,
"subcategory": "Economy",
"model": "Dzire or Similar",
"sourceAddress": "Mahipalpur, New Delhi, Delhi, India",
"sourceState": "Delhi",
"destinationAddress": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India",
"destinationState": "Delhi",
"rating": 4.8,
"ratingCount": 77,
"filterTag": "Sedan",
"journeyType": "AIRPORT",
"driverLocations": [],
"cabLocations": [],
"tripStop": null,
"expiryTime": "1778043181754",
"whatsappConsent": true,
"memberShipId": null,
"partner_ref_no": null,
"partnerType": "OPS_AGENT",
"tripStartAt": null,
"tripEndAt": null,
"historyToken": "17KxjjS4kdAh9wqn9b4fFFt1GUWdAGgKnTTaehK5Irya9WgE039DVt-PviC0zIt-TTBSWK6i",
"opsRemarks": null,
"opsRemarkCreatedAt": null,
"remarkCount": 0,
"deviceType": "unknown",
"userAgent": "unknown",
"customerReview": null,
"customerRating": null,
"reviewCreatedAt": null,
"reviewCount": 0,
"isExtraFareShown": false,
"isRemainingAmountShown": false,
"indigo_listing_fee_percent": null,
"indigo_listing_fee_inr": null,
"partner_fee_percent": null,
"partner_fee_inr": null,
"loyalty_points_disbursed": null,
"partnerResponse": null,
"cancelledBy": null,
"cancellationReason": null,
"poweredBy": null,
"rebrandDetails": {},
"eta": null,
"driverToSourceKm": "0.00",
"sourceToDestinationKm": "0.00",
"startPolling": 0,
"extraDetails": {
"totalFare": 330,
"rideFare": 314,
"gstOnRideFare": 16,
"serviceFees": null,
"gstOnServiceFees": null,
"tollCharges": null,
"interStateCharges": null,
"parkingCharges": 0,
"driverBata": null,
"nightCharges": null,
"additionalCharges": null,
"tollChargesIncluded": null,
"interStateTaxesIncluded": null,
"extraKmFare": null,
"extraHourFare": null,
"seatCapacity": "2",
"luggageCapacity": "2",
"airportEntryFeeAmount": 0,
"fuelType": "CNG"
},
"loyaltyPoints": 16,
"rawFareData": {
"Base Fare": 314,
"Parking Charges": 0,
"GST": 16,
"Total Fare": 330,
"Final Fare": 0
},
"fareDisplayStr": {
"Base Fare": "₹314",
"GST": "₹16",
"Total Fare": "₹330"
},
"serializedFareDisplay": [
{
"label": "Base Fare",
"value": "₹314",
"key": "baseFare"
},
{
"label": "GST",
"value": "₹16",
"key": "gST"
},
{
"label": "Total Fare",
"value": "₹330",
"key": "totalFare"
}
],
"fareDisplay": {
"Base Fare": "₹314",
"GST": "₹16",
"Total Fare": "₹330"
},
"paymentDetails": {},
"consentIndigoTnC": false,
"consentDataSharing": false,
"consentMojoboxxTnC": 1,
"fallBackBooking": false,
"bluechip": false,
"searchId": "5a59603a-ce2e-4cc7-a0d2-78647c690797|6681b2de126c22902b8ac33b69deeaa6eea89a4ce5de5c92da593866d378c487",
"trackingUrl": "https://s6web-uat.goindigo.in/cabs/itinerary.html?token=17KxjjS4kdAh9wqn9b4fFFt1GUWdAGgKnTTaehK5Irya9WgE039DVt-PviC0zIt-TTBSWK6i",
"extraFare": 0,
"paymentToBeCollect": 0,
"tripCompleteFareDisplay": {}
}
],
"correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3"
}
-
status: Status of the API response.
- Possible values:
success,failure
- Possible values:
- message: Descriptive message returned by the API.
- code: HTTP status code returned by the API.
-
data: Array containing booking details.
- bookingId: Unique identifier for the booking.
- parentBookingId: Parent booking reference identifier.
- userName: Customer full name.
- mobile: Customer mobile number.
- email: Customer email address.
- gender: Customer gender if available.
- image: Desktop booking partner logo URL.
- imageMobile: Mobile optimized partner logo URL.
- imageApp: App specific partner logo URL.
- pickupTime: Scheduled pickup time in ISO 8601 format.
- dropOffTime: Estimated drop-off time in ISO 8601 format.
-
cabPartner: Cab service provider.
- Examples:
SIGNATURE,QUICKRIDE,GOZOCABS
- Examples:
- referenceNumber: Unique booking reference number.
- bookingTime: Timestamp when the booking was created.
- sourceName: Pickup location name.
- sourceLatitude: Pickup latitude coordinate.
- sourceLongitude: Pickup longitude coordinate.
- destinationName: Drop location name.
- destinationLatitude: Drop latitude coordinate.
- destinationLongitude: Drop longitude coordinate.
- cityCode: Airport/city code.
- kilometer: Total ride distance in kilometers.
- totalFare: Total fare amount.
- couponCode: Applied coupon code if available.
- discountApplied: Discount amount applied.
- paidAmount: Amount already paid by the customer.
- remainingAmount: Remaining amount to be paid.
-
paymentStatus: Current payment status.
- Possible values:
Paid,Unpaid,Partially Paid
- Possible values:
- tripProgress: Numeric value representing trip progress state.
-
payType: Payment type selected by customer.
- Examples:
FULL,PARTIAL,CASH
- Examples:
- paymentMethod: Payment gateway/method used for payment.
-
travelType: Type of airport transfer.
- Examples:
departure,arrival
- Examples:
- otherDetails: Additional booking instructions/details.
- cabAssigned: Indicates whether cab has been assigned.
- cabLeftForPickup: Indicates whether cab has left for pickup.
- cabReachedSource: Indicates whether cab reached pickup point.
- cabTripStarted: Indicates whether trip has started.
- cabTripEnd: Indicates whether trip has ended.
- features: Additional cab features.
- freeCancellationTill: Free cancellation window in minutes.
- extraKmFare: Extra kilometer fare.
- fuelType: Fuel type of vehicle.
- driverName: Assigned driver name.
- driverMobile: Assigned driver contact number.
- vehicleNumber: Assigned vehicle registration number.
- otp: OTP shared with customer for ride verification.
-
vehicleType: Vehicle category.
- Examples:
Sedan,SUV,Hatchback
- Examples:
-
fuelType: Fuel type of vehicle.
- Possible values:
PETROL,DIESEL,CNG,ELECTRIC
- Possible values:
- seats: Seating capacity of vehicle.
-
airConditioned: Indicates whether AC is available.
-
1= Yes,0= No
-
- extraPerKm: Extra distance fare per kilometer.
- inclusion: List of fare inclusions.
- exclusion: List of fare exclusions.
- fareDetails: Basic fare breakup.
- baseFare: Base ride fare.
- tax: Applicable tax amount.
- tollCharges: Toll charges.
- serviceCharge: Service/convenience fee.
-
status: Current booking status.
- Possible values:
PREBOOK,BOOKING_CONFIRMED,CANCELLED,COMPLETED
- Possible values:
-
isBooked: Indicates whether booking is confirmed.
-
1= Yes,0= No
-
- supportEmail: Customer support email address.
- supportContact: Customer support contact number.
- cancellationCharge: Applicable cancellation fee.
- refundAmount: Refund amount if booking was cancelled.
- subcategory: Vehicle pricing category.
- model: Vehicle model name/category.
- sourceAddress: Complete pickup address.
- sourceState: Pickup state name.
- destinationAddress: Complete drop address.
- destinationState: Drop state name.
- rating: Average partner rating.
- ratingCount: Total number of ratings.
- filterTag: Vehicle filter category shown in UI.
- journeyType: Journey category type.
- driverLocations: Array of driver live location updates.
- cabLocations: Array of cab tracking location updates.
- tripStop: Additional trip stop details if applicable.
- expiryTime: Booking expiry timestamp.
- whatsappConsent: Indicates whether customer consented to WhatsApp notifications.
- partnerType: Operational partner category.
- historyToken: Secure token used for itinerary/tracking access.
- deviceType: Device type used during booking.
- userAgent: User agent/device information.
- extraDetails: Detailed fare breakup information.
- totalFare: Total payable fare.
- rideFare: Ride fare excluding taxes.
- gstOnRideFare: GST charged on ride fare.
- serviceFees: Additional service fees.
- gstOnServiceFees: GST charged on service fees.
- tollCharges: Toll charges applicable.
- interStateCharges: Interstate charges.
- parkingCharges: Parking charges.
- driverBata: Driver allowance amount.
- nightCharges: Night charges if applicable.
- additionalCharges: Additional miscellaneous charges.
- tollChargesIncluded: Indicates whether toll charges are included.
- interStateTaxesIncluded: Indicates whether interstate taxes are included.
- extraKmFare: Extra kilometer fare.
- extraHourFare: Extra hourly fare.
- seatCapacity: Passenger seating capacity.
- luggageCapacity: Luggage carrying capacity.
- airportEntryFeeAmount: Airport entry charges.
- fuelType: Fuel type of vehicle.
- loyaltyPoints: Loyalty/reward points earned.
- rawFareData: Raw fare breakup values.
- fareDisplayStr: Formatted fare breakup for display.
- serializedFareDisplay: Serialized fare breakup array for frontend rendering.
- fareDisplay: UI formatted fare display object.
- paymentDetails: Additional payment related details.
- trackingUrl: URL used for booking itinerary/tracking.
- extraFare: Additional fare collected after ride completion.
- paymentToBeCollect: Pending payment amount to be collected.
- tripCompleteFareDisplay: Final trip fare breakup shown after ride completion.
- correlationId: Unique identifier used for request tracing and debugging.
Error Responses:
{ "status": "failure", "message": "Booking ID does not exist", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Missing bookingId", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Access denied. No token provided.", "code": 401 }
{ "status": "failure", "message": "Internal server error'", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
Booking History
▶Endpoint:
/api/v1/booking/bookingHistory
Method: POST
Idempotent: YES
Description: Fetch booking details by booking ID.
Validation:
- mobileNumber (String, Required): Mobile number of the user. Must be a valid 10-digit number.
- page (Number, Optional): Page number for pagination. Must be greater than or equal to 1. Defaults to 1.
- limit (Number, Optional): Number of records per page. Must be between 1 and 10. Defaults to 2.
- search (String, Optional): Search term for filtering bookings. Can be an empty string.
-
rides (String, Optional): Filter for ride type. Valid values are:
- upcoming: Fetch upcoming rides.
- past: Fetch past rides.
- all: Fetch all rides (default).
-
status (String, Optional): Filter for booking status. Valid values are:
- PREBOOK
- PAYMENT_CAPTURED
- BOOKING_CONFIRMED
- CANCELLED
- COMPLETED
Request Example:
{ "mobileNumber": "9599962319", "page": 1, "limit": 2, "rides": "", "status": "" }
Sample cURL Request:
curl --location '{{baseUrl}}/api/v1/booking/bookingHistory' \
--header 'correlationId: 6731c8eb-8509-49b8-b526-8184f8c917b3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NCwidXNlcm5hbWUiOiJpeGlnbyIsInBhcnRuZXJfbmFtZSI6Iml4aWdvIiwiY2xpZW50X2lkIjoiSVhHIiwiaWF0IjoxNzQ2MjQ2OTQ5LCJleHAiOjE3NDYyNTA1NDl9.3ol0Zis0-nu503s_v20bVTe-6O0Q6lMppiJLBU4MD0I' \
--header 'Cookie: connect.sid=s%3AMeJ4ENxUdNkFaWVGsxkXVs1-7I7tQJWc.FsL7nl%2B7j8EVzsBx%2Fj5drPOyqBd6mu6JRxbLKkYKgPk' \
--data '{
"mobileNumber":"9599962319",
"page":1,
"limit" : 1,
"rides" : "",
"status" : ""
}'Response Example:
{
"status": "success",
"message": "Booking history fetched successfully",
"code": 200,
"data": [
{
"bookingId": "JCRAN060526095401LCXB",
"parentBookingId": "JCRAN060526095401LCXB",
"userName": "customer name",
"mobile": "9999999999",
"email": "abc@mojoboxx.com",
"gender": null,
"image": "https://cdn.bookairportcab.com/June-30-2025/BAC-84.png",
"imageMobile": "https://cdn.bookairportcab.com/June-30-2025/BAC-38.png",
"imageApp": "https://cdn.bookairportcab.com/June-30-2025/BAC-84.png",
"pickupTime": "2026-05-08T02:00:00.000Z",
"dropOffTime": "2026-05-08T02:19:00.000Z",
"cabPartner": "SIGNATURE",
"referenceNumber": "93659ace-0d8a-417d-9b0d-673db39f9f53",
"bookingTime": "2026-05-06 09:54:01",
"sourceName": "Mahipalpur, New Delhi, Delhi, India",
"sourceLatitude": "28.5448686000",
"sourceLongitude": "77.1281345000",
"destinationName": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India",
"destinationLatitude": "28.5550838000",
"destinationLongitude": "77.0818266000",
"cityCode": "DEL",
"kilometer": 8.2,
"totalFare": 330,
"couponCode": null,
"discountApplied": 0,
"paidAmount": 0,
"remainingAmount": 330,
"paymentStatus": "Unpaid",
"tripProgress": 0,
"payType": "",
"paymentMethod": null,
"travelType": "departure",
"otherDetails": "Please be on time",
"cabAssigned": 0,
"cabLeftForPickup": 0,
"cabReachedSource": 0,
"cabTripStarted": 0,
"cabTripEnd": 0,
"features": {
"freeCancellationTill": 30,
"extraKmFare": 25,
"fuelType": "Cng"
},
"driverName": null,
"driverMobile": null,
"vehicleNumber": null,
"otp": null,
"vehicleType": "Sedan",
"fuelType": "Cng",
"seats": 2,
"airConditioned": 1,
"extraPerKm": 25,
"inclusion": [
"8.2 Kms Ride",
"GST: INR 16"
],
"exclusion": [
"Extra Km Fare: INR 25/Km",
"Waiting Charges (after 30 mins) 100/30 mins",
"Airport parking charges may apply as per destination airport rules.",
"Toll charges(if applicable and not included in fare) are payable against a valid receipt.",
"If no receipt is provided for any extra charge, contact care@bookairportcab.com for assistance"
],
"fareDetails": {
"baseFare": 314,
"tax": 16,
"tollCharges": 0,
"serviceCharge": 0
},
"status": "PREBOOK",
"isBooked": 0,
"supportEmail": "care@bookairportcab.com",
"supportContact": "+918046800969",
"cabPartnerResponse": null,
"cancellationCharge": 0,
"refundAmount": 0,
"subcategory": "Economy",
"model": "Dzire or Similar",
"sourceAddress": "Mahipalpur, New Delhi, Delhi, India",
"sourceState": "Delhi",
"destinationAddress": "Indira Gandhi International Airport - Terminal 3, New Delhi, Delhi, India",
"destinationState": "Delhi",
"rating": 4.8,
"ratingCount": 77,
"filterTag": "Sedan",
"journeyType": "AIRPORT",
"driverLocations": [],
"cabLocations": [],
"tripStop": null,
"expiryTime": "1778043181754",
"whatsappConsent": true,
"memberShipId": null,
"partner_ref_no": null,
"partnerType": "OPS_AGENT",
"tripStartAt": null,
"tripEndAt": null,
"historyToken": "17KxjjS4kdAh9wqn9b4fFFt1GUWdAGgKnTTaehK5Irya9WgE039DVt-PviC0zIt-TTBSWK6i",
"opsRemarks": null,
"opsRemarkCreatedAt": null,
"remarkCount": 0,
"deviceType": "unknown",
"userAgent": "unknown",
"customerReview": null,
"customerRating": null,
"reviewCreatedAt": null,
"reviewCount": 0,
"isExtraFareShown": false,
"isRemainingAmountShown": false,
"indigo_listing_fee_percent": null,
"indigo_listing_fee_inr": null,
"partner_fee_percent": null,
"partner_fee_inr": null,
"loyalty_points_disbursed": null,
"partnerResponse": null,
"cancelledBy": null,
"cancellationReason": null,
"poweredBy": null,
"rebrandDetails": {},
"eta": null,
"driverToSourceKm": "0.00",
"sourceToDestinationKm": "0.00",
"startPolling": 0,
"extraDetails": {
"totalFare": 330,
"rideFare": 314,
"gstOnRideFare": 16,
"serviceFees": null,
"gstOnServiceFees": null,
"tollCharges": null,
"interStateCharges": null,
"parkingCharges": 0,
"driverBata": null,
"nightCharges": null,
"additionalCharges": null,
"tollChargesIncluded": null,
"interStateTaxesIncluded": null,
"extraKmFare": null,
"extraHourFare": null,
"seatCapacity": "2",
"luggageCapacity": "2",
"airportEntryFeeAmount": 0,
"fuelType": "CNG"
},
"loyaltyPoints": 16,
"rawFareData": {
"Base Fare": 314,
"Parking Charges": 0,
"GST": 16,
"Total Fare": 330,
"Final Fare": 0
},
"fareDisplayStr": {
"Base Fare": "₹314",
"GST": "₹16",
"Total Fare": "₹330"
},
"serializedFareDisplay": [
{
"label": "Base Fare",
"value": "₹314",
"key": "baseFare"
},
{
"label": "GST",
"value": "₹16",
"key": "gST"
},
{
"label": "Total Fare",
"value": "₹330",
"key": "totalFare"
}
],
"fareDisplay": {
"Base Fare": "₹314",
"GST": "₹16",
"Total Fare": "₹330"
},
"paymentDetails": {},
"consentIndigoTnC": false,
"consentDataSharing": false,
"consentMojoboxxTnC": 1,
"fallBackBooking": false,
"bluechip": false,
"searchId": "5a59603a-ce2e-4cc7-a0d2-78647c690797|6681b2de126c22902b8ac33b69deeaa6eea89a4ce5de5c92da593866d378c487",
"trackingUrl": "https://s6web-uat.goindigo.in/cabs/itinerary.html?token=17KxjjS4kdAh9wqn9b4fFFt1GUWdAGgKnTTaehK5Irya9WgE039DVt-PviC0zIt-TTBSWK6i",
"extraFare": 0,
"paymentToBeCollect": 0,
"tripCompleteFareDisplay": {}
}
],
"correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3"
}
-
status: Status of the API response.
- Possible values:
success,failure
- Possible values:
- message: Descriptive message returned by the API.
- code: HTTP status code returned by the API.
-
data: Array containing booking details.
- bookingId: Unique identifier for the booking.
- parentBookingId: Parent booking reference identifier.
- userName: Customer full name.
- mobile: Customer mobile number.
- email: Customer email address.
- gender: Customer gender if available.
- image: Desktop booking partner logo URL.
- imageMobile: Mobile optimized partner logo URL.
- imageApp: App specific partner logo URL.
- pickupTime: Scheduled pickup time in ISO 8601 format.
- dropOffTime: Estimated drop-off time in ISO 8601 format.
-
cabPartner: Cab service provider.
- Examples:
SIGNATURE,QUICKRIDE,GOZOCABS
- Examples:
- referenceNumber: Unique booking reference number.
- bookingTime: Timestamp when the booking was created.
- sourceName: Pickup location name.
- sourceLatitude: Pickup latitude coordinate.
- sourceLongitude: Pickup longitude coordinate.
- destinationName: Drop location name.
- destinationLatitude: Drop latitude coordinate.
- destinationLongitude: Drop longitude coordinate.
- cityCode: Airport/city code.
- kilometer: Total ride distance in kilometers.
- totalFare: Total fare amount.
- couponCode: Applied coupon code if available.
- discountApplied: Discount amount applied.
- paidAmount: Amount already paid by the customer.
- remainingAmount: Remaining amount to be paid.
-
paymentStatus: Current payment status.
- Possible values:
Paid,Unpaid,Partially Paid
- Possible values:
- tripProgress: Numeric value representing trip progress state.
-
payType: Payment type selected by customer.
- Examples:
FULL,PARTIAL,CASH
- Examples:
- paymentMethod: Payment gateway/method used for payment.
-
travelType: Type of airport transfer.
- Examples:
departure,arrival
- Examples:
- otherDetails: Additional booking instructions/details.
- cabAssigned: Indicates whether cab has been assigned.
- cabLeftForPickup: Indicates whether cab has left for pickup.
- cabReachedSource: Indicates whether cab reached pickup point.
- cabTripStarted: Indicates whether trip has started.
- cabTripEnd: Indicates whether trip has ended.
- features: Additional cab features.
- freeCancellationTill: Free cancellation window in minutes.
- extraKmFare: Extra kilometer fare.
- fuelType: Fuel type of vehicle.
- driverName: Assigned driver name.
- driverMobile: Assigned driver contact number.
- vehicleNumber: Assigned vehicle registration number.
- otp: OTP shared with customer for ride verification.
-
vehicleType: Vehicle category.
- Examples:
Sedan,SUV,Hatchback
- Examples:
-
fuelType: Fuel type of vehicle.
- Possible values:
PETROL,DIESEL,CNG,ELECTRIC
- Possible values:
- seats: Seating capacity of vehicle.
-
airConditioned: Indicates whether AC is available.
-
1= Yes,0= No
-
- extraPerKm: Extra distance fare per kilometer.
- inclusion: List of fare inclusions.
- exclusion: List of fare exclusions.
- fareDetails: Basic fare breakup.
- baseFare: Base ride fare.
- tax: Applicable tax amount.
- tollCharges: Toll charges.
- serviceCharge: Service/convenience fee.
-
status: Current booking status.
- Possible values:
PREBOOK,BOOKING_CONFIRMED,CANCELLED,COMPLETED
- Possible values:
-
isBooked: Indicates whether booking is confirmed.
-
1= Yes,0= No
-
- supportEmail: Customer support email address.
- supportContact: Customer support contact number.
- cancellationCharge: Applicable cancellation fee.
- refundAmount: Refund amount if booking was cancelled.
- subcategory: Vehicle pricing category.
- model: Vehicle model name/category.
- sourceAddress: Complete pickup address.
- sourceState: Pickup state name.
- destinationAddress: Complete drop address.
- destinationState: Drop state name.
- rating: Average partner rating.
- ratingCount: Total number of ratings.
- filterTag: Vehicle filter category shown in UI.
- journeyType: Journey category type.
- driverLocations: Array of driver live location updates.
- cabLocations: Array of cab tracking location updates.
- tripStop: Additional trip stop details if applicable.
- expiryTime: Booking expiry timestamp.
- whatsappConsent: Indicates whether customer consented to WhatsApp notifications.
- partnerType: Operational partner category.
- historyToken: Secure token used for itinerary/tracking access.
- deviceType: Device type used during booking.
- userAgent: User agent/device information.
- extraDetails: Detailed fare breakup information.
- totalFare: Total payable fare.
- rideFare: Ride fare excluding taxes.
- gstOnRideFare: GST charged on ride fare.
- serviceFees: Additional service fees.
- gstOnServiceFees: GST charged on service fees.
- tollCharges: Toll charges applicable.
- interStateCharges: Interstate charges.
- parkingCharges: Parking charges.
- driverBata: Driver allowance amount.
- nightCharges: Night charges if applicable.
- additionalCharges: Additional miscellaneous charges.
- tollChargesIncluded: Indicates whether toll charges are included.
- interStateTaxesIncluded: Indicates whether interstate taxes are included.
- extraKmFare: Extra kilometer fare.
- extraHourFare: Extra hourly fare.
- seatCapacity: Passenger seating capacity.
- luggageCapacity: Luggage carrying capacity.
- airportEntryFeeAmount: Airport entry charges.
- fuelType: Fuel type of vehicle.
- loyaltyPoints: Loyalty/reward points earned.
- rawFareData: Raw fare breakup values.
- fareDisplayStr: Formatted fare breakup for display.
- serializedFareDisplay: Serialized fare breakup array for frontend rendering.
- fareDisplay: UI formatted fare display object.
- paymentDetails: Additional payment related details.
- trackingUrl: URL used for booking itinerary/tracking.
- extraFare: Additional fare collected after ride completion.
- paymentToBeCollect: Pending payment amount to be collected.
- tripCompleteFareDisplay: Final trip fare breakup shown after ride completion.
- correlationId: Unique identifier used for request tracing and debugging.
Error Responses:
{ "status": "failure", "message": "Invalid request parameters: \"mobileNumber\" is required", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "No booking history found for the given mobileNumber", "code": 404, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Internal server error'", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Access denied. No token provided.", "code": 401 }
Cancel Booking
▶Endpoint:
/api/v1/booking/cancelBooking
Method: POST
Idempotent: No
Description: Cancel booking by booking ID.
Validation:
- bookingId (String, Required):Unique ID of the booking for which you want to see details.
- cancelledBy (String, Required):Possible values are USER, ADMIN, PARTNER
- cancellationReason (String, Required):Reason of cancellation.
- Booking must be cancelled at least 1 minute before the Pickup Time.
- There is no charge on booking cancellation.
- Bookings with status CANCELLED or COMPLETED cannot be cancelled again
Sample cURL Request:
curl --location '{{baseUrl}}/api/v1/booking/cancelBooking' \
--header 'correlationId: 6731c8eb-8509-49b8-b526-8184f8c917b3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ***************' \
--data '{
"bookingId": "JCRWE0205201259223OBR",
"cancelledBy": "USER",
"cancellationReason": "Change in plan"
}'
Request Example:
{ "bookingId": "JCRWE0205201259223OBR", "cancelledBy": "USER", "cancellationReason": "Change in plan" }
Response Example:
{ "status": "success", "message": "Booking cancelled successfully", "code": 200, "data": { "bookingId": "JCRWE0205201259223OBR", "status": "Cancelled", "cancellation_reason": "Change in plan" }, "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
- status (String) - Indicates the response status (e.g., "success").
- message (String) - Describes the outcome of the cancellation request.
- code (Number) - HTTP status code (e.g., 200 = success).
- data (Object) - Contains details of the cancelled booking:
- bookingId (String) - Unique identifier of the cancelled booking.
- status (String) - Status of the booking (e.g., "CANCELLED").
- cancellation_reason (String) - Reason provided for the cancellation.
- correlationId (String) - Unique request identifier for traceability and logging.
Error Responses:
{ "status": "failure", "message": "Invalid request parameters: \"bookingId\" is required", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "No booking found for the given bookingId", "code": 404, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Access denied. No token provided.", "code": 401 }
{ "status": "failure", "message": "Internal server error'", "code": 500, "error": "error message", "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Booking is already in CANCELLED status", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Booking is already in COMPLETE status", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }
{ "status": "failure", "message": "Booking cannot be cancelled within 1 minute of start time", "code": 400, "data": [], "correlationId": "6731c8eb-8509-49b8-b526-8184f8c917b3" }