{ "info": { "name": "RideX API v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "The mobile API used by the Rider and Driver apps. Regenerate this file after changing routes: `php artisan ridex:api-collection`.\n\n1. Set the `baseUrl` variable to `{APP_URL}/api/v1`.\n\n2. Sign in with **auth.otp.send**, then **auth.otp.verify** (in demo mode: +1 5550000001 with code 123456), and copy `data.token` into the `token` variable.\n\n3. Every response uses the same envelope: `{success, message, data, meta, errors, error_code}`. Send `X-Locale` (`en`, `ar`, …) for translated messages." }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "http://127.0.0.1:8000/api/v1" }, { "key": "token", "value": "" }, { "key": "locale", "value": "en" } ], "item": [ { "name": "Config", "item": [ { "name": "config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/config", "host": [ "{{baseUrl}}" ], "path": [ "config" ] }, "description": "No sign-in needed: branding, currency, languages, phone country, active vehicle types, code lengths and every public setting.", "auth": { "type": "noauth" } } } ] }, { "name": "Content", "item": [ { "name": "content.pages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/pages", "host": [ "{{baseUrl}}" ], "path": [ "content", "pages" ] }, "description": "The information pages an app lists (About, Terms, Privacy...), each with its public web address.", "auth": { "type": "noauth" } } }, { "name": "content.page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/pages/:slug", "host": [ "{{baseUrl}}" ], "path": [ "content", "pages", ":slug" ], "variable": [ { "key": "slug", "value": "" } ] }, "description": "One active information page by its slug, with the title and content translated; 404 when it is missing or switched off.", "auth": { "type": "noauth" } } }, { "name": "content.faqs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/faqs", "host": [ "{{baseUrl}}" ], "path": [ "content", "faqs" ] }, "description": "Active help-centre questions for the app, in sort order, each with its category and the translated question and answer.", "auth": { "type": "noauth" } } }, { "name": "content.banners", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/banners", "host": [ "{{baseUrl}}" ], "path": [ "content", "banners" ], "query": [ { "key": "zone_id", "value": "1", "disabled": true }, { "key": "lat", "value": "40.758", "disabled": true }, { "key": "lng", "value": "-73.9855", "disabled": true } ] }, "description": "Live banners for the zone at ?lat&lng (or ?zone_id); banners without a zone show everywhere.\n\n- `zone_id` · integer\n- `lat` · required_with:lng, numeric, between:-90,90\n- `lng` · required_with:lat, numeric, between:-180,180", "auth": { "type": "noauth" } } }, { "name": "content.cancellation-reasons", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/cancellation-reasons", "host": [ "{{baseUrl}}" ], "path": [ "content", "cancellation-reasons" ] }, "description": "The reasons the app offers when cancelling a ride, translated and in sort order.", "auth": { "type": "noauth" } } }, { "name": "content.cities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/cities", "host": [ "{{baseUrl}}" ], "path": [ "content", "cities" ] }, "description": "Operating cities (driver onboarding picks one).", "auth": { "type": "noauth" } } }, { "name": "content.quick-messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/quick-messages", "host": [ "{{baseUrl}}" ], "path": [ "content", "quick-messages" ] }, "description": "One-tap replies the app offers in the trip chat, translated and in sort order.", "auth": { "type": "noauth" } } }, { "name": "content.rating-tags", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/content/rating-tags", "host": [ "{{baseUrl}}" ], "path": [ "content", "rating-tags" ] }, "description": "Compliment tags the app offers when rating the other person.", "auth": { "type": "noauth" } } } ] }, { "name": "Trips", "item": [ { "name": "trips.share", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/trips/share/:token", "host": [ "{{baseUrl}}" ], "path": [ "trips", "share", ":token" ], "variable": [ { "key": "token", "value": "" } ] }, "description": "No sign-in, secret token: status, pickup, drop, first names, the driver's live position and the car; 410 once the ride has ended.", "auth": { "type": "noauth" } } } ] }, { "name": "Auth", "item": [ { "name": "auth.otp.send", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/otp/send", "host": [ "{{baseUrl}}" ], "path": [ "auth", "otp", "send" ] }, "description": "Texts a sign-in or phone-change code and returns its lifetime; refused when sign-in runs on Firebase Phone Auth instead.\n\n- `country_code` **required** · string, regex:/^\\+\\d{1,4}$/\n- `phone` **required** · string, regex:/^\\d{5,14}$/\n- `purpose` · in:\"login\",\"change_phone\"", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"country_code\": \"+1\",\n \"phone\": \"5550000001\",\n \"purpose\": \"login\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "auth.otp.verify", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/otp/verify", "host": [ "{{baseUrl}}" ], "path": [ "auth", "otp", "verify" ] }, "description": "Checks the texted code, then signs in or creates the account; wrong, expired or over-tried codes and blocked accounts are refused.\n\n- `country_code` **required** · string, regex:/^\\+\\d{1,4}$/\n- `phone` **required** · string, regex:/^\\d{5,14}$/\n- `user_type` **required** · in:\"rider\",\"driver\"\n- `referral_code` · string, max:20, exists:users,referral_code,user_type,\"NULL\",deleted_at,\"NULL\"\n- `fcm_token` · string, max:255\n- `device_type` · in:\"android\",\"ios\"\n- `device_name` · string, max:100\n- `app_version` · string, max:20\n- `code` **required** · string, regex:/^\\d{4,8}$/", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"country_code\": \"+1\",\n \"phone\": \"5550000001\",\n \"user_type\": \"rider\",\n \"referral_code\": \"\",\n \"fcm_token\": \"\",\n \"device_type\": \"android\",\n \"device_name\": \"\",\n \"app_version\": \"\",\n \"code\": \"123456\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "auth.firebase", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/firebase", "host": [ "{{baseUrl}}" ], "path": [ "auth", "firebase" ] }, "description": "Signs in or signs up with a Firebase Phone Auth ID token; refuses a phone number that differs from the one Firebase verified.\n\n- `country_code` **required** · string, regex:/^\\+\\d{1,4}$/\n- `phone` **required** · string, regex:/^\\d{5,14}$/\n- `user_type` **required** · in:\"rider\",\"driver\"\n- `referral_code` · string, max:20, exists:users,referral_code,user_type,\"NULL\",deleted_at,\"NULL\"\n- `fcm_token` · string, max:255\n- `device_type` · in:\"android\",\"ios\"\n- `device_name` · string, max:100\n- `app_version` · string, max:20\n- `id_token` **required** · string, max:4096", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"country_code\": \"+1\",\n \"phone\": \"5550000001\",\n \"user_type\": \"rider\",\n \"referral_code\": \"\",\n \"fcm_token\": \"\",\n \"device_type\": \"android\",\n \"device_name\": \"\",\n \"app_version\": \"\",\n \"id_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "auth.social", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/social", "host": [ "{{baseUrl}}" ], "path": [ "auth", "social" ] }, "description": "Google or Apple sign-in: verifies the ID token, then signs in, links by email or creates the account; 403 when that provider is off.\n\n- `user_type` **required** · in:\"rider\",\"driver\"\n- `referral_code` · string, max:20, exists:users,referral_code,user_type,\"NULL\",deleted_at,\"NULL\"\n- `fcm_token` · string, max:255\n- `device_type` · in:\"android\",\"ios\"\n- `device_name` · string, max:100\n- `app_version` · string, max:20\n- `provider` **required** · in:\"google\",\"apple\"\n- `id_token` **required** · string, max:4096\n- `name` · string, max:100", "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"user_type\": \"rider\",\n \"referral_code\": \"\",\n \"fcm_token\": \"\",\n \"device_type\": \"android\",\n \"device_name\": \"\",\n \"app_version\": \"\",\n \"provider\": \"google\",\n \"id_token\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "auth.me", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/me", "host": [ "{{baseUrl}}" ], "path": [ "auth", "me" ] }, "description": "The signed-in user; for drivers, also the driver profile with its current vehicle and vehicle type." } }, { "name": "auth.logout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/logout", "host": [ "{{baseUrl}}" ], "path": [ "auth", "logout" ] }, "description": "Revokes this device's token and clears its push token; drivers also go offline so dispatch skips them." } }, { "name": "auth.fcm-token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/fcm-token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "fcm-token" ] }, "description": "Saves the phone's FCM push token, with the device type and app version when sent.\n\n- `fcm_token` **required** · string, max:255\n- `device_type` · in:\"android\",\"ios\"\n- `app_version` · string, max:20", "body": { "mode": "raw", "raw": "{\n \"fcm_token\": \"\",\n \"device_type\": \"android\",\n \"app_version\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "auth.delete-account", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/auth/account", "host": [ "{{baseUrl}}" ], "path": [ "auth", "account" ] }, "description": "Deletes the account as app stores require: personal data is wiped, rides and payments are kept; refused during an active ride." } } ] }, { "name": "Profile", "item": [ { "name": "profile.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/profile", "host": [ "{{baseUrl}}" ], "path": [ "profile" ] }, "description": "The signed-in user's profile, with the driver profile for drivers." } }, { "name": "profile.update", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/profile", "host": [ "{{baseUrl}}" ], "path": [ "profile" ] }, "description": "Also used for \"profile completion\" right after the first login.\n\n- `name` **required** · custom, string, min:2, max:100\n- `email` · email:rfc, max:150, unique\n- `gender` · in\n- `date_of_birth` · custom, date, custom\n- `address` · string, max:255\n- `avatar` · custom, image, custom", "body": { "mode": "formdata", "formdata": [ { "key": "name", "type": "text" }, { "key": "email", "type": "text", "value": "user@example.com" }, { "key": "gender", "type": "text" }, { "key": "date_of_birth", "type": "text", "value": "2030-01-01" }, { "key": "address", "type": "text" }, { "key": "avatar", "type": "file" } ] } } }, { "name": "profile.phone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/profile/phone", "host": [ "{{baseUrl}}" ], "path": [ "profile", "phone" ] }, "description": "Add a phone (social sign-ups) or change it. Ownership proven by OTP or Firebase token.\n\n- `country_code` **required** · string, regex:/^\\+\\d{1,4}$/\n- `phone` **required** · string, regex:/^\\d{5,14}$/\n- `code` · required_without:firebase_id_token, string, regex:/^\\d{4,8}$/\n- `firebase_id_token` · required_without:code, string, max:4096", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"+1\",\n \"phone\": \"5550000001\",\n \"code\": \"123456\",\n \"firebase_id_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "profile.language", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/profile/language", "host": [ "{{baseUrl}}" ], "path": [ "profile", "language" ] }, "description": "Saves the user's language (an active language code); notifications sent to them then use it.\n\n- `language` **required** · string, exists:languages,code,is_active,\"1\"", "body": { "mode": "raw", "raw": "{\n \"language\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "profile.notification-preferences", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/profile/notification-preferences", "host": [ "{{baseUrl}}" ], "path": [ "profile", "notification-preferences" ] }, "description": "Switches notification types and channels on or off; keys not sent keep their value, and safety alerts always go out.\n\n- `preferences` **required** · array\n- `preferences.ride_updates` · boolean\n- `preferences.chat` · boolean\n- `preferences.payments` · boolean\n- `preferences.promotions` · boolean\n- `preferences.news` · boolean\n- `preferences.sms` · boolean\n- `preferences.email` · boolean", "body": { "mode": "raw", "raw": "{\n \"preferences\": {\n \"ride_updates\": true,\n \"chat\": true,\n \"payments\": true,\n \"promotions\": true,\n \"news\": true,\n \"sms\": true,\n \"email\": true\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Wallet", "item": [ { "name": "wallet.balance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/wallet", "host": [ "{{baseUrl}}" ], "path": [ "wallet" ] }, "description": "The balance, any dues owed (the negative part), the currency and the top-up limits." } }, { "name": "wallet.transactions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/wallet/transactions", "host": [ "{{baseUrl}}" ], "path": [ "wallet", "transactions" ] }, "description": "The user's wallet ledger, newest first and paginated, each entry with the record behind it." } } ] }, { "name": "Referrals", "item": [ { "name": "referrals.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/referrals", "host": [ "{{baseUrl}}" ], "path": [ "referrals" ] }, "description": "The user's invite code, the reward amounts, the total earned and everyone they invited with each reward's status." } } ] }, { "name": "Payments", "item": [ { "name": "payments.methods", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/payments/methods", "host": [ "{{baseUrl}}" ], "path": [ "payments", "methods" ] }, "description": "Methods and gateways switched on in Admin → Payment Configuration." } }, { "name": "payments.top-up", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/payments/wallet/top-up", "host": [ "{{baseUrl}}" ], "path": [ "payments", "wallet", "top-up" ] }, "description": "Opens a wallet top-up checkout on the chosen gateway; refused when the wallet is off, below the minimum or past the balance cap.\n\n- `amount` **required** · numeric, min:0.01, max:99999999\n- `gateway` **required** · string, max:30", "body": { "mode": "raw", "raw": "{\n \"amount\": 1,\n \"gateway\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "payments.confirm", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/payments/:payment/confirm", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment", "confirm" ], "variable": [ { "key": "payment", "value": "" } ] }, "description": "Asks the gateway how the user's own payment went once the hosted page closes; when paid, the money moves exactly once." } }, { "name": "payments.history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/payments/history", "host": [ "{{baseUrl}}" ], "path": [ "payments", "history" ] }, "description": "The user's payments, newest first and paginated, each with its ride." } } ] }, { "name": "Notifications", "item": [ { "name": "notifications.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] }, "description": "The user's notifications, newest first and paginated, with the unread count in meta." } }, { "name": "notifications.unread-count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/notifications/unread-count", "host": [ "{{baseUrl}}" ], "path": [ "notifications", "unread-count" ] }, "description": "For the app's badge." } }, { "name": "notifications.read-all", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/notifications/read-all", "host": [ "{{baseUrl}}" ], "path": [ "notifications", "read-all" ] }, "description": "Marks every unread notification as read; the unread count comes back as 0." } }, { "name": "notifications.read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/notifications/:id/read", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":id", "read" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Marks one of the user's own notifications as read and returns the new unread count; 404 for any other id." } } ] }, { "name": "Rides", "item": [ { "name": "chat.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rides/:ride/chat", "host": [ "{{baseUrl}}" ], "path": [ "rides", ":ride", "chat" ], "variable": [ { "key": "ride", "value": "" } ], "query": [ { "key": "after_id", "value": "1", "disabled": true } ] }, "description": "Messages on this ride, oldest first; with after_id only newer ones. Only the ride's rider and driver may read them.\n\n- `after_id` · integer, min:1" } }, { "name": "chat.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rides/:ride/chat", "host": [ "{{baseUrl}}" ], "path": [ "rides", ":ride", "chat" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Sends a text or quick reply and pushes it to the other person; refused when chat is off, before a driver accepts or after the trip.\n\n- `message` **required** · string, custom\n- `type` · in:\"text\",\"quick_reply\"", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"type\": \"text\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "chat.read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rides/:ride/chat/read", "host": [ "{{baseUrl}}" ], "path": [ "rides", ":ride", "chat", "read" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Marks the messages sent to the signed-in user on this ride as read; only the ride's rider and driver may call it." } } ] }, { "name": "Realtime", "item": [ { "name": "realtime.token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/realtime/token", "host": [ "{{baseUrl}}" ], "path": [ "realtime", "token" ] }, "description": "A Firebase custom token, the database URL and the paths this user may listen to; 503 when Firebase is not set up, so the app polls." } } ] }, { "name": "SOS", "item": [ { "name": "sos.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/sos", "host": [ "{{baseUrl}}" ], "path": [ "sos" ] }, "description": "Raises an SOS on the given or current ride and texts the emergency contacts; pressing again soon after updates the open alert.\n\n- `ride_uuid` · uuid\n- `lat` · required_with:lng, numeric, between:-90,90\n- `lng` · required_with:lat, numeric, between:-180,180", "body": { "mode": "raw", "raw": "{\n \"ride_uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"lat\": 40.758,\n \"lng\": -73.9855\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Support tickets", "item": [ { "name": "support-tickets.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/support-tickets", "host": [ "{{baseUrl}}" ], "path": [ "support-tickets" ] }, "description": "The user's tickets, most recently updated first and paginated, each with its ride." } }, { "name": "support-tickets.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/support-tickets", "host": [ "{{baseUrl}}" ], "path": [ "support-tickets" ] }, "description": "Opens a ticket at its category's default priority; a fare dispute must name one of the user's own rides.\n\n- `category` **required** · in:\"general\",\"ride_issue\",\"fare_dispute\",\"payment\",\"safety\",\"driver_behavior\",\"lost_item\",\"account\",\"other\"\n- `subject` **required** · string, max:150\n- `description` **required** · string, max:2000\n- `ride_uuid` · , uuid\n- `disputed_amount` · numeric, gt:0, max:1000000", "body": { "mode": "raw", "raw": "{\n \"category\": \"general\",\n \"subject\": \"\",\n \"description\": \"\",\n \"ride_uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"disputed_amount\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "support-tickets.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/support-tickets/:support_ticket", "host": [ "{{baseUrl}}" ], "path": [ "support-tickets", ":support_ticket" ], "variable": [ { "key": "support_ticket", "value": "" } ] }, "description": "One of the user's own tickets with its ride and replies; 404 for anyone else's." } }, { "name": "support-tickets.reply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/support-tickets/:support_ticket/reply", "host": [ "{{baseUrl}}" ], "path": [ "support-tickets", ":support_ticket", "reply" ], "variable": [ { "key": "support_ticket", "value": "" } ] }, "description": "Adds the user's reply to their own ticket (404 otherwise) and puts it back in the support queue; closed tickets are refused.\n\n- `message` **required** · string, custom", "body": { "mode": "raw", "raw": "{\n \"message\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Rider", "item": [ { "name": "Home", "item": [ { "name": "rider.home", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/home", "host": [ "{{baseUrl}}" ], "path": [ "rider", "home" ], "query": [ { "key": "lat", "value": "40.758", "disabled": true }, { "key": "lng", "value": "-73.9855", "disabled": true } ] }, "description": "The rider home screen in one call: the active ride, saved places, live banners and the zone at ?lat&lng.\n\n- `lat` · numeric, between:-90,90\n- `lng` · numeric, between:-180,180" } } ] }, { "name": "Nearby drivers", "item": [ { "name": "rider.nearby-drivers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/nearby-drivers", "host": [ "{{baseUrl}}" ], "path": [ "rider", "nearby-drivers" ], "query": [ { "key": "lat", "value": "40.758", "disabled": false }, { "key": "lng", "value": "-73.9855", "disabled": false }, { "key": "vehicle_type_id", "value": "1", "disabled": true } ] }, "description": "Available cars around a point for the home map.\n\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180\n- `vehicle_type_id` · integer" } } ] }, { "name": "Places", "item": [ { "name": "rider.places.autocomplete", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/places/autocomplete", "host": [ "{{baseUrl}}" ], "path": [ "rider", "places", "autocomplete" ], "query": [ { "key": "q", "value": "", "disabled": false }, { "key": "lat", "value": "40.758", "disabled": true }, { "key": "lng", "value": "-73.9855", "disabled": true }, { "key": "session_token", "value": "", "disabled": true } ] }, "description": "Google Places suggestions for the typed text (2+ characters), biased towards ?lat&lng; an empty list when Google is not set up or fails.\n\n- `q` **required** · string, min:2, max:200\n- `lat` · numeric, between:-90,90, required_with:lng\n- `lng` · numeric, between:-180,180, required_with:lat\n- `session_token` · string, regex:/^[A-Za-z0-9_-]{1,36}$/" } }, { "name": "rider.places.reverse", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/places/reverse", "host": [ "{{baseUrl}}" ], "path": [ "rider", "places", "reverse" ], "query": [ { "key": "lat", "value": "40.758", "disabled": false }, { "key": "lng", "value": "-73.9855", "disabled": false } ] }, "description": "The readable address at a GPS point (e.g. for \"Current location\"); the coordinates themselves when Google gives none.\n\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180" } }, { "name": "rider.places.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/places/:placeId", "host": [ "{{baseUrl}}" ], "path": [ "rider", "places", ":placeId" ], "variable": [ { "key": "placeId", "value": "" } ], "query": [ { "key": "session_token", "value": "", "disabled": true } ] }, "description": "A suggestion's name, address and coordinates in the request language, cached; 404 when Google returns no such place.\n\n- `session_token` · string, regex:/^[A-Za-z0-9_-]{1,36}$/" } } ] }, { "name": "Fare estimate", "item": [ { "name": "rider.fare-estimate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/fare-estimate", "host": [ "{{baseUrl}}" ], "path": [ "rider", "fare-estimate" ] }, "description": "One priced option per vehicle type offered at the pickup, each with a quote_id for booking; 422 when no type serves the trip there.\n\n- `ride_type` **required** · in:\"instant\",\"scheduled\",\"rental\",\"outstation\"\n- `pickup` **required** · array\n- `pickup.lat` **required** · numeric, between:-90,90\n- `pickup.lng` **required** · numeric, between:-180,180\n- `drop` **required** · array\n- `drop.lat` **required** · numeric, between:-90,90\n- `drop.lng` **required** · numeric, between:-180,180\n- `stops` · array, max:3\n- `stops.*.lat` **required** · numeric, between:-90,90\n- `stops.*.lng` **required** · numeric, between:-180,180\n- `scheduled_at` · date, after_or_equal:29 minutes from now, before_or_equal:1 week from now\n- `rental_hours` · integer, min:1, max:24\n- `is_round_trip` · boolean\n- `outstation_days` · integer, min:1, max:30\n- `vehicle_type_id` · integer, exists:vehicle_types,id,is_active,\"1\",deleted_at,\"NULL\"\n- `promo_code` · string, max:30", "body": { "mode": "raw", "raw": "{\n \"ride_type\": \"instant\",\n \"pickup\": {\n \"lat\": 40.758,\n \"lng\": -73.9855\n },\n \"drop\": {\n \"lat\": 40.758,\n \"lng\": -73.9855\n },\n \"stops\": [\n {\n \"lat\": 40.758,\n \"lng\": -73.9855\n }\n ],\n \"scheduled_at\": \"2030-01-01\",\n \"rental_hours\": 1,\n \"is_round_trip\": true,\n \"outstation_days\": 1,\n \"vehicle_type_id\": 1,\n \"promo_code\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Rental packages", "item": [ { "name": "rider.rental-packages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rental-packages", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rental-packages" ], "query": [ { "key": "lat", "value": "40.758", "disabled": false }, { "key": "lng", "value": "-73.9855", "disabled": false } ] }, "description": "The rental package hours any active vehicle type offers at the pickup, from each type's fare plan, unique and sorted.\n\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180" } } ] }, { "name": "Promo codes", "item": [ { "name": "rider.promo-codes.validate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/promo-codes/validate", "host": [ "{{baseUrl}}" ], "path": [ "rider", "promo-codes", "validate" ] }, "description": "Checks a code for this rider and the pickup at ?lat&lng; 422 with the reason when it is invalid, expired, used up or not usable.\n\n- `code` **required** · string, max:30", "body": { "mode": "raw", "raw": "{\n \"code\": \"123456\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.promo-codes.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/promo-codes", "host": [ "{{baseUrl}}" ], "path": [ "rider", "promo-codes" ] }, "description": "Valid codes this rider can still use, newest first; codes limited to areas only show when ?lat&lng is inside one of them." } } ] }, { "name": "Rides", "item": [ { "name": "rider.rides.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides" ] }, "description": "The rider's rides, newest first and paginated; ?status takes a comma-separated list of statuses." } }, { "name": "rider.rides.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides" ] }, "description": "Books at the quoted price and starts dispatch (scheduled rides wait); refused for an expired quote, a ride in progress or unpaid dues.\n\n- `quote_id` **required** · uuid\n- `payment_method` **required** · in:\"cash\",\"card\",\"wallet\",\"online\"\n- `pickup_address` **required** · string, max:500\n- `drop_address` · string, max:500\n- `stop_addresses` · array, max:3\n- `stop_addresses.*` · string, max:500\n- `pickup_note` · string, max:500\n- `passenger_name` · string, max:100, required_with:passenger_phone\n- `passenger_phone` · string, max:30, required_with:passenger_name", "body": { "mode": "raw", "raw": "{\n \"quote_id\": \"00000000-0000-0000-0000-000000000000\",\n \"payment_method\": \"cash\",\n \"pickup_address\": \"\",\n \"drop_address\": \"\",\n \"stop_addresses\": [\n \"\"\n ],\n \"pickup_note\": \"\",\n \"passenger_name\": \"\",\n \"passenger_phone\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.rides.active", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/active", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", "active" ] }, "description": "The rider's ride in progress with its driver, vehicle, stops and unread chat count, or null when there is none." } }, { "name": "rider.rides.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "One of the rider's own rides with its driver, vehicle, stops and unread chat count; 404 for anyone else's." } }, { "name": "rider.rides.cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride/cancel", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride", "cancel" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Cancels the rider's own ride; free before a driver is assigned and for a grace period after, then a fee applies. Refused once started.\n\n- `reason` · string, max:500", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.rides.share", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride/share", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride", "share" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Link for trusted contacts to follow the trip live; stops working when the ride ends." } }, { "name": "rider.rides.tip", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride/tip", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride", "tip" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Wallet tips are sent at once; card / online tips return a checkout page to open.\n\n- `amount` **required** · numeric, min:0.01\n- `method` **required** · in:\"wallet\",\"card\",\"online\"\n- `gateway` · required_unless:method,wallet, string, max:30", "body": { "mode": "raw", "raw": "{\n \"amount\": 1,\n \"method\": \"wallet\",\n \"gateway\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.rides.payment-method", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride/payment-method", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride", "payment-method" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Switches the payment method before the ride ends; once an unpaid card or online ride has ended, only the wallet can settle it.\n\n- `payment_method` **required** · in:\"cash\",\"card\",\"wallet\",\"online\"", "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"cash\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.rides.receipt", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride/receipt", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride", "receipt" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "The receipt of the rider's own completed ride, or of a cancelled one charged a fee, with its payments; 404 otherwise." } }, { "name": "rider.rides.rate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride/rate", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride", "rate" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Rates the other person on a completed ride the user was on (404 otherwise) and updates their average; one rating each per ride.\n\n- `rating` **required** · integer, custom\n- `review` · string, custom\n- `tags` · array\n- `tags.*` · string, distinct, in", "body": { "mode": "raw", "raw": "{\n \"rating\": 1,\n \"review\": \"\",\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.lost-items.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/rides/:ride/lost-items", "host": [ "{{baseUrl}}" ], "path": [ "rider", "rides", ":ride", "lost-items" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Reports an item left on the rider's own completed ride and tells the driver; refused before completion or after the reporting window.\n\n- `item_name` **required** · string, max:100\n- `description` · string, max:1000\n- `contact_phone` · string, max:20, regex:/^\\+?[\\d\\s-]{5,20}$/", "body": { "mode": "raw", "raw": "{\n \"item_name\": \"\",\n \"description\": \"\",\n \"contact_phone\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Lost items", "item": [ { "name": "rider.lost-items.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/lost-items", "host": [ "{{baseUrl}}" ], "path": [ "rider", "lost-items" ] }, "description": "The rider's lost-item reports, newest first and paginated, each with its ride." } } ] }, { "name": "Saved places", "item": [ { "name": "rider.saved-places.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-places", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-places" ] }, "description": "The rider's saved places, sorted by label and newest first within each label." } }, { "name": "rider.saved-places.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-places", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-places" ] }, "description": "Saves a place for the rider; there can be only one home and one work place.\n\n- `label` **required** · in, when\n- `name` **required** · string, max:100\n- `address` **required** · string, max:500\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"name\": \"\",\n \"address\": \"\",\n \"lat\": 40.758,\n \"lng\": -73.9855\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.saved-places.update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-places/:saved_place", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-places", ":saved_place" ], "variable": [ { "key": "saved_place", "value": "" } ] }, "description": "Edits one of the rider's own places (still one home and one work at most); 404 for anyone else's.\n\n- `label` **required** · in, when\n- `name` **required** · string, max:100\n- `address` **required** · string, max:500\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"name\": \"\",\n \"address\": \"\",\n \"lat\": 40.758,\n \"lng\": -73.9855\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "rider.saved-places.destroy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-places/:saved_place", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-places", ":saved_place" ], "variable": [ { "key": "saved_place", "value": "" } ] }, "description": "Removes one of the rider's own places; 404 for anyone else's." } } ] }, { "name": "Emergency contacts", "item": [ { "name": "rider.emergency-contacts.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/emergency-contacts", "host": [ "{{baseUrl}}" ], "path": [ "rider", "emergency-contacts" ] }, "description": "The rider's emergency contacts, by name." } }, { "name": "rider.emergency-contacts.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/emergency-contacts", "host": [ "{{baseUrl}}" ], "path": [ "rider", "emergency-contacts" ] }, "description": "Adds an emergency contact; refused once the rider has the maximum allowed in the safety settings." } }, { "name": "rider.emergency-contacts.update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/emergency-contacts/:emergency_contact", "host": [ "{{baseUrl}}" ], "path": [ "rider", "emergency-contacts", ":emergency_contact" ], "variable": [ { "key": "emergency_contact", "value": "" } ] }, "description": "Edits one of the rider's own contacts; 404 for anyone else's." } }, { "name": "rider.emergency-contacts.destroy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/emergency-contacts/:emergency_contact", "host": [ "{{baseUrl}}" ], "path": [ "rider", "emergency-contacts", ":emergency_contact" ], "variable": [ { "key": "emergency_contact", "value": "" } ] }, "description": "Removes one of the rider's own contacts; 404 for anyone else's." } } ] }, { "name": "Payments", "item": [ { "name": "rider.payments.pay-ride", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/payments/rides/:ride/pay", "host": [ "{{baseUrl}}" ], "path": [ "rider", "payments", "rides", ":ride", "pay" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Opens a checkout for the rider's own completed card or online ride (404 for others); refused when nothing is left to pay.\n\n- `gateway` **required** · string, max:30", "body": { "mode": "raw", "raw": "{\n \"gateway\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Saved cards", "item": [ { "name": "rider.saved-cards.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-cards", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-cards" ] }, "description": "The rider's cards, default first, after syncing them with Stripe; 422 when saved cards are not available." } }, { "name": "rider.saved-cards.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-cards", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-cards" ] }, "description": "Opens Stripe's page to add a card; the app lists the cards again when it returns." } }, { "name": "rider.saved-cards.destroy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-cards/:saved_card", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-cards", ":saved_card" ], "variable": [ { "key": "saved_card", "value": "" } ] }, "description": "Removes one of the rider's own cards at Stripe and here; another card becomes the default when needed." } }, { "name": "rider.saved-cards.default", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/rider/saved-cards/:saved_card/default", "host": [ "{{baseUrl}}" ], "path": [ "rider", "saved-cards", ":saved_card", "default" ], "variable": [ { "key": "saved_card", "value": "" } ] }, "description": "Makes one of the rider's own cards the default, the one charged when a card ride ends." } } ] } ] }, { "name": "Driver", "item": [ { "name": "Onboarding", "item": [ { "name": "driver.onboarding.status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/onboarding", "host": [ "{{baseUrl}}" ], "path": [ "driver", "onboarding" ] }, "description": "The driver's checklist: approval status, rejection reason, can_submit and the profile, documents and vehicle steps." } }, { "name": "driver.onboarding.profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/onboarding/profile", "host": [ "{{baseUrl}}" ], "path": [ "driver", "onboarding", "profile" ] }, "description": "Step 1: saves the personal details, photo and city and returns the updated checklist; identity fields are locked once verified.\n\n- `name` **required** · custom, string, min:2, max:100\n- `email` · email:rfc, max:150, unique\n- `city_id` **required** · integer, exists\n- `gender` · in\n- `date_of_birth` **required** · custom, date, custom\n- `address` · string, max:255\n- `avatar` · custom, image, custom", "body": { "mode": "formdata", "formdata": [ { "key": "name", "type": "text" }, { "key": "email", "type": "text", "value": "user@example.com" }, { "key": "city_id", "type": "text", "value": "1" }, { "key": "gender", "type": "text" }, { "key": "date_of_birth", "type": "text", "value": "2030-01-01" }, { "key": "address", "type": "text" }, { "key": "avatar", "type": "file" } ] } } }, { "name": "driver.onboarding.submit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/onboarding/submit", "host": [ "{{baseUrl}}" ], "path": [ "driver", "onboarding", "submit" ] }, "description": "Sends the application to admin review; refused while a step is incomplete, or once it is under review or approved." } } ] }, { "name": "Documents", "item": [ { "name": "driver.documents.requirements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/documents/requirements", "host": [ "{{baseUrl}}" ], "path": [ "driver", "documents", "requirements" ] }, "description": "Which documents exist and their rules – lets the app build upload forms dynamically." } }, { "name": "driver.documents.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/documents", "host": [ "{{baseUrl}}" ], "path": [ "driver", "documents" ] }, "description": "The driver's current documents, newest first; ?vehicle_id narrows them to one vehicle." } }, { "name": "driver.documents.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/documents", "host": [ "{{baseUrl}}" ], "path": [ "driver", "documents" ] }, "description": "Uploads a document for review; it replaces older copies of that type, except an approved one still in force.\n\n- `document_type` **required** · in:\"profile_photo\",\"national_id\",\"driving_license\",\"vehicle_registration\",\"insurance\",\"fitness_certificate\",\"other\"\n- `vehicle_id` · prohibited\n- `file_front` **required** · file, mimes:jpg,jpeg,png,webp,pdf, max:5120\n- `file_back` · file, mimes:jpg,jpeg,png,webp,pdf, max:5120\n- `document_number` · string, max:100\n- `expires_at` · date, after:today", "body": { "mode": "formdata", "formdata": [ { "key": "document_type", "type": "text", "value": "profile_photo" }, { "key": "vehicle_id", "type": "text" }, { "key": "file_front", "type": "file" }, { "key": "file_back", "type": "file" }, { "key": "document_number", "type": "text" }, { "key": "expires_at", "type": "text", "value": "2030-01-01" } ] } } }, { "name": "driver.documents.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/documents/:document", "host": [ "{{baseUrl}}" ], "path": [ "driver", "documents", ":document" ], "variable": [ { "key": "document", "value": "" } ] }, "description": "One of the driver's own documents with its review status; 404 for anyone else's." } }, { "name": "driver.documents.reupload", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/documents/:document/reupload", "host": [ "{{baseUrl}}" ], "path": [ "driver", "documents", ":document", "reupload" ], "variable": [ { "key": "document", "value": "" } ] }, "description": "A new copy of the driver's own document (same type and vehicle) for review, e.g. after a rejection or before it expires.\n\n- `file_front` **required** · file, mimes:jpg,jpeg,png,webp,pdf, max:5120\n- `file_back` · file, mimes:jpg,jpeg,png,webp,pdf, max:5120\n- `document_number` · string, max:100\n- `expires_at` · date, after:today", "body": { "mode": "formdata", "formdata": [ { "key": "file_front", "type": "file" }, { "key": "file_back", "type": "file" }, { "key": "document_number", "type": "text" }, { "key": "expires_at", "type": "text", "value": "2030-01-01" } ] } } } ] }, { "name": "Vehicles", "item": [ { "name": "driver.vehicles.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/vehicles", "host": [ "{{baseUrl}}" ], "path": [ "driver", "vehicles" ] }, "description": "The driver's vehicles, the active one first and then newest, each with its type and documents." } }, { "name": "driver.vehicles.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/vehicles", "host": [ "{{baseUrl}}" ], "path": [ "driver", "vehicles" ] }, "description": "Adds a vehicle (with an optional photo) awaiting review; the driver's first vehicle becomes the active one.\n\n- `vehicle_type_id` **required** · integer, exists:vehicle_types,id,is_active,\"1\",deleted_at,\"NULL\"\n- `make` **required** · string, max:50\n- `model` **required** · string, max:50\n- `year` **required** · integer, min:1990, max:2027\n- `color` **required** · string, max:30\n- `plate_number` **required** · string, min:2, max:20, unique:vehicles,plate_number,NULL,id\n- `seats` · integer, min:1, max:20\n- `image` · image, max:5120", "body": { "mode": "formdata", "formdata": [ { "key": "vehicle_type_id", "type": "text", "value": "1" }, { "key": "make", "type": "text" }, { "key": "model", "type": "text" }, { "key": "year", "type": "text", "value": "1" }, { "key": "color", "type": "text" }, { "key": "plate_number", "type": "text" }, { "key": "seats", "type": "text", "value": "1" }, { "key": "image", "type": "file" } ] } } }, { "name": "driver.vehicles.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/vehicles/:vehicle", "host": [ "{{baseUrl}}" ], "path": [ "driver", "vehicles", ":vehicle" ], "variable": [ { "key": "vehicle", "value": "" } ] }, "description": "One of the driver's own vehicles with its type and documents; 404 for anyone else's." } }, { "name": "driver.vehicles.update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/vehicles/:vehicle", "host": [ "{{baseUrl}}" ], "path": [ "driver", "vehicles", ":vehicle" ], "variable": [ { "key": "vehicle", "value": "" } ] }, "description": "Edits the driver's own vehicle; a new type, plate, make, model or year sends an approved one back to review. Refused mid-trip.\n\n- `vehicle_type_id` **required** · integer, exists:vehicle_types,id,is_active,\"1\",deleted_at,\"NULL\"\n- `make` **required** · string, max:50\n- `model` **required** · string, max:50\n- `year` **required** · integer, min:1990, max:2027\n- `color` **required** · string, max:30\n- `plate_number` **required** · string, min:2, max:20, unique:vehicles,plate_number,NULL,id\n- `seats` · integer, min:1, max:20\n- `image` · image, max:5120", "body": { "mode": "formdata", "formdata": [ { "key": "vehicle_type_id", "type": "text", "value": "1" }, { "key": "make", "type": "text" }, { "key": "model", "type": "text" }, { "key": "year", "type": "text", "value": "1" }, { "key": "color", "type": "text" }, { "key": "plate_number", "type": "text" }, { "key": "seats", "type": "text", "value": "1" }, { "key": "image", "type": "file" } ] } } }, { "name": "driver.vehicles.destroy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/vehicles/:vehicle", "host": [ "{{baseUrl}}" ], "path": [ "driver", "vehicles", ":vehicle" ], "variable": [ { "key": "vehicle", "value": "" } ] }, "description": "Removes the driver's own vehicle and its documents, promoting another if it was active; refused on a trip or while online in it." } }, { "name": "driver.vehicles.default", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/vehicles/:vehicle/default", "host": [ "{{baseUrl}}" ], "path": [ "driver", "vehicles", ":vehicle", "default" ], "variable": [ { "key": "vehicle", "value": "" } ] }, "description": "Makes this the driver's only active vehicle; once the driver is approved, only an approved vehicle can be chosen. Refused mid-trip." } } ] }, { "name": "Home", "item": [ { "name": "driver.home", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/home", "host": [ "{{baseUrl}}" ], "path": [ "driver", "home" ] }, "description": "Everything the driver home screen needs: online state, today's totals, rating, wallet, vehicle, active ride, open offer and destination." } } ] }, { "name": "Status", "item": [ { "name": "driver.status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/status", "host": [ "{{baseUrl}}" ], "path": [ "driver", "status" ] }, "description": "Going online checks the phone, the documents and unpaid dues; going offline is refused during a trip and hands open offers on.\n\n- `online` **required** · boolean", "body": { "mode": "raw", "raw": "{\n \"online\": true\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Location", "item": [ { "name": "driver.location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/location", "host": [ "{{baseUrl}}" ], "path": [ "driver", "location" ] }, "description": "Takes one GPS fix or a buffered batch and returns how many points were kept; jumps are dropped, mock GPS refused when blocking is on.\n\n- `is_mock` · boolean\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180\n- `heading` · integer, between:0,359\n- `recorded_at` · date", "body": { "mode": "raw", "raw": "{\n \"is_mock\": true,\n \"lat\": 40.758,\n \"lng\": -73.9855,\n \"heading\": 1,\n \"recorded_at\": \"2030-01-01\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Heatmap", "item": [ { "name": "driver.heatmap", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/heatmap", "host": [ "{{baseUrl}}" ], "path": [ "driver", "heatmap" ] }, "description": "Recent ride requests binned into grid cells around the driver, plus zones currently surging." } } ] }, { "name": "Destination", "item": [ { "name": "driver.destination.update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/destination", "host": [ "{{baseUrl}}" ], "path": [ "driver", "destination" ] }, "description": "Head somewhere (e.g. home): only trips that end closer to it are offered. Counts against today's limit.\n\n- `address` **required** · string, max:255\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180", "body": { "mode": "raw", "raw": "{\n \"address\": \"\",\n \"lat\": 40.758,\n \"lng\": -73.9855\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "driver.destination.destroy", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/destination", "host": [ "{{baseUrl}}" ], "path": [ "driver", "destination" ] }, "description": "Stop heading to the destination: every trip is offered again." } } ] }, { "name": "Places", "item": [ { "name": "driver.places.autocomplete", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/places/autocomplete", "host": [ "{{baseUrl}}" ], "path": [ "driver", "places", "autocomplete" ], "query": [ { "key": "q", "value": "", "disabled": false }, { "key": "lat", "value": "40.758", "disabled": true }, { "key": "lng", "value": "-73.9855", "disabled": true }, { "key": "session_token", "value": "", "disabled": true } ] }, "description": "Google Places suggestions for the typed text (2+ characters), biased towards ?lat&lng; an empty list when Google is not set up or fails.\n\n- `q` **required** · string, min:2, max:200\n- `lat` · numeric, between:-90,90, required_with:lng\n- `lng` · numeric, between:-180,180, required_with:lat\n- `session_token` · string, regex:/^[A-Za-z0-9_-]{1,36}$/" } }, { "name": "driver.places.reverse", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/places/reverse", "host": [ "{{baseUrl}}" ], "path": [ "driver", "places", "reverse" ], "query": [ { "key": "lat", "value": "40.758", "disabled": false }, { "key": "lng", "value": "-73.9855", "disabled": false } ] }, "description": "The readable address at a GPS point (e.g. for \"Current location\"); the coordinates themselves when Google gives none.\n\n- `lat` **required** · numeric, between:-90,90\n- `lng` **required** · numeric, between:-180,180" } }, { "name": "driver.places.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/places/:placeId", "host": [ "{{baseUrl}}" ], "path": [ "driver", "places", ":placeId" ], "variable": [ { "key": "placeId", "value": "" } ], "query": [ { "key": "session_token", "value": "", "disabled": true } ] }, "description": "A suggestion's name, address and coordinates in the request language, cached; 404 when Google returns no such place.\n\n- `session_token` · string, regex:/^[A-Za-z0-9_-]{1,36}$/" } } ] }, { "name": "Ride requests", "item": [ { "name": "driver.ride-requests.current", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/ride-requests/current", "host": [ "{{baseUrl}}" ], "path": [ "driver", "ride-requests", "current" ] }, "description": "The driver's newest offer still inside its countdown, with the ride and rider, or null when there is none." } }, { "name": "driver.ride-requests.accept", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/ride-requests/:rideRequest/accept", "host": [ "{{baseUrl}}" ], "path": [ "driver", "ride-requests", ":rideRequest", "accept" ], "variable": [ { "key": "rideRequest", "value": "" } ] }, "description": "Accepts the driver's own offer and returns the ride; refused on an untrusted phone, after expiry, once taken or while on a trip." } }, { "name": "driver.ride-requests.reject", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/ride-requests/:rideRequest/reject", "host": [ "{{baseUrl}}" ], "path": [ "driver", "ride-requests", ":rideRequest", "reject" ], "variable": [ { "key": "rideRequest", "value": "" } ] }, "description": "Declines the driver's own offer (optional reason) and offers the ride to the next driver; an already answered offer is left alone.\n\n- `reason` · string, max:255", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Trips", "item": [ { "name": "driver.trips.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips" ] }, "description": "The driver's trips, newest first and paginated; ?status takes a comma-separated list of statuses." } }, { "name": "driver.trips.active", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/active", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", "active" ] }, "description": "The driver's ride in progress with its stops, rider and unread chat count, or null when there is none." } }, { "name": "driver.trips.show", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "One of the driver's own trips with its stops, rider and the rating the driver gave; 404 for anyone else's." } }, { "name": "driver.trips.arrived", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride/arrived", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride", "arrived" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Marks the driver at the pickup and tells the rider; refused unless accepted, or when a fresh GPS fix is too far from the pickup." } }, { "name": "driver.trips.start", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride/start", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride", "start" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Starts the trip after arrival once the rider's PIN matches (when PINs are on) and records the waiting time.\n\n- `otp` · custom, string, max:10", "body": { "mode": "raw", "raw": "{\n \"otp\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "driver.trips.stops.arrived", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride/stops/:stop/arrived", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride", "stops", ":stop", "arrived" ], "variable": [ { "key": "ride", "value": "" }, { "key": "stop", "value": "" } ] }, "description": "Marks a stop on the driver's own started trip as reached (the first time only); 404 for a stop on another ride." } }, { "name": "driver.trips.complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride/complete", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride", "complete" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Ends the trip: final fare from the GPS trail or the app's distance plus tolls, then settlement and rewards; card rides are charged.\n\n- `distance_km` **required** · numeric, min:0, max:10000\n- `tolls` · numeric, min:0, max:200", "body": { "mode": "raw", "raw": "{\n \"distance_km\": 1,\n \"tolls\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "driver.trips.cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride/cancel", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride", "cancel" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Cancels before the trip starts: a rider no-show (after the free wait) charges the rider's fee, any other reason re-dispatches the ride.\n\n- `reason` **required** · string, max:500\n- `rider_no_show` · boolean", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\",\n \"rider_no_show\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "driver.trips.collect-cash", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride/collect-cash", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride", "collect-cash" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Records the rider's cash as paid on the driver's own completed cash trip; refused when there is no cash left to collect." } }, { "name": "driver.trips.rate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/trips/:ride/rate", "host": [ "{{baseUrl}}" ], "path": [ "driver", "trips", ":ride", "rate" ], "variable": [ { "key": "ride", "value": "" } ] }, "description": "Rates the other person on a completed ride the user was on (404 otherwise) and updates their average; one rating each per ride.\n\n- `rating` **required** · integer, custom\n- `review` · string, custom\n- `tags` · array\n- `tags.*` · string, distinct, in", "body": { "mode": "raw", "raw": "{\n \"rating\": 1,\n \"review\": \"\",\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Earnings", "item": [ { "name": "driver.earnings.summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/earnings", "host": [ "{{baseUrl}}" ], "path": [ "driver", "earnings" ], "query": [ { "key": "period", "value": "", "disabled": true } ] }, "description": "?period=today|week|month (default today).\n\n- `period` · in" } }, { "name": "driver.earnings.trips", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/earnings/trips", "host": [ "{{baseUrl}}" ], "path": [ "driver", "earnings", "trips" ] }, "description": "The driver's completed trips, latest first and paginated, with the fare, commission, earning and tip of each." } } ] }, { "name": "Withdrawals", "item": [ { "name": "driver.withdrawals.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/withdrawals", "host": [ "{{baseUrl}}" ], "path": [ "driver", "withdrawals" ] }, "description": "The balance, the minimum withdrawal, the masked payout details, the open request and recent requests." } }, { "name": "driver.withdrawals.store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/withdrawals", "host": [ "{{baseUrl}}" ], "path": [ "driver", "withdrawals" ] }, "description": "Requests a payout for the finance team and debits the wallet at once.\nRefused on an untrusted phone, without payout details, below the minimum, above the balance or while another is open.\n\n- `amount` **required** · numeric, min:0.01, max:99999999", "body": { "mode": "raw", "raw": "{\n \"amount\": 1\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Payout details", "item": [ { "name": "driver.payout-details", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/payout-details", "host": [ "{{baseUrl}}" ], "path": [ "driver", "payout-details" ] }, "description": "Saves where payouts go (bank, mobile money or PayPal), encrypted, and returns them masked; refused on an untrusted phone.\n\n- `method` **required** · in:\"bank_transfer\",\"mobile_money\",\"paypal\"\n- `account_name` **required** · string, max:100\n- `bank_name` · required_if:method,bank_transfer, string, max:100\n- `account_number` · required_if:method,bank_transfer,mobile_money, string, max:40\n- `routing_code` · string, max:40\n- `provider` · required_if:method,mobile_money, string, max:50\n- `paypal_email` · required_if:method,paypal, email, max:150", "body": { "mode": "raw", "raw": "{\n \"method\": \"bank_transfer\",\n \"account_name\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\",\n \"routing_code\": \"\",\n \"provider\": \"\",\n \"paypal_email\": \"user@example.com\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Incentives", "item": [ { "name": "driver.incentives.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/incentives", "host": [ "{{baseUrl}}" ], "path": [ "driver", "incentives" ] }, "description": "Running targets for the driver's city and vehicle type with live progress; a target reached is paid into the wallet once." } } ] }, { "name": "Lost items", "item": [ { "name": "driver.lost-items.index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/lost-items", "host": [ "{{baseUrl}}" ], "path": [ "driver", "lost-items" ] }, "description": "Lost items reported on the driver's trips, newest first and paginated, each with its ride." } }, { "name": "driver.lost-items.update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/driver/lost-items/:lostItem", "host": [ "{{baseUrl}}" ], "path": [ "driver", "lost-items", ":lostItem" ], "variable": [ { "key": "lostItem", "value": "" } ] }, "description": "Answers a report on the driver's own trip as found, returned or not found, and tells the rider; closed reports are refused.\n\n- `status` **required** · in:\"reported\",\"driver_contacted\",\"found\",\"returned\",\"not_found\",\"closed\"\n- `response` · string, max:1000", "body": { "mode": "raw", "raw": "{\n \"status\": \"reported\",\n \"response\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Webhooks", "item": [ { "name": "webhooks.payments", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-Locale", "value": "{{locale}}" } ], "url": { "raw": "{{baseUrl}}/webhooks/payments/:gateway", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "payments", ":gateway" ], "variable": [ { "key": "gateway", "value": "" } ] }, "description": "Checks the gateway's signature (400 when invalid) and re-checks the payment it names; unknown payments get a plain 200.", "auth": { "type": "noauth" } } } ] } ] }