Ride Hailing
This page discuss the extended information for ride hailing scenarios, please also check the base API.
Order Status
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/394843ca-78d4-45fd-8d10-3a0ff61aa390.png\" "\\"image.png\\"")
Notification can start from any status below and status can be skipped if necessary. |
Order Status | Description | Display Sample (Index Page) |
PENDING | When finding a driver for this order. |
|
BOOKED | When the vehicle is booked but the driver has not started coming to pick-up. **This status is for pre-book vehicle only. |
|
ORDER_TAKEN | When the order is taken by a driver. Progress bar is calculated by service_start_time, driver_board_duration and current system timestamp. |
**Progress = (current system timestamp - service_start_time) / driver_board_duration |
TO_BOARD | When the user has to board. |
|
SERVING | When the journey begins. Progress bar is calculated by service_start_time, ride_dest_duration and current system timestamp. |
**Progress = (current system timestamp - service_start_time) / ride_dest_duration |
WAIT_PAY | When the user has to pay. |
|
FINISHED | When the order completes or if it is cancelled by the user. | Notification will disappear. |
TO_SEND | When finding another driver for this order. |
|
CLOSED | When the order is cancelled by the driver, notification will disappear after 5 mins. |
|
CANCEL_WAIT_PAY | When the order is cancelled by the user, but waiting for user to pay. | Notification will disappear. |
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/3174cb92-e134-4ced-bbda-c1a156fcadeb.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/fa346010-2740-4bf4-90e8-91d489612304.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/ae0742c0-c172-4081-88ef-b421f4819154.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/2d87022e-2e9c-4996-acad-a27e9c03db5e.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/5f1a7a1c-33a3-43ff-9922-ff297a02d6cc.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2025/png/a0b557f7-0bd7-4415-9ef0-46e3b93852cc.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/d4c3bf64-10d3-42e4-8c8b-6307728473b8.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/4d263bea-fbba-4cb4-80d0-31cf5512c4ef.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/37f21e71-9b87-48f2-877b-d94f79fc9217.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/0821f8a3-540e-42f9-8f27-04c41ed83877.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/4f5b76e9-152f-4cf2-8c0b-0a4046c024cd.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/fe4d5ff9-d2b1-41d4-b368-2d06f1de0056.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/95fe111f-1ccd-43cc-b3ff-3cf94fd82802.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/0082437e-6412-453a-bb76-5c7e26b5f1cc.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/cdaaf517-7d46-4e33-85f3-f98b11c8051e.png\" "\\"image.png\\"")
![\"image.png\"](\"https://idocs-assets.marmot-cloud.com/storage/idocs87c36dc8dac653c1/yuque/idocs/2024/png/bfc41311-30d3-4dbe-8a3f-acd7d99c45fc.png\" "\\"image.png\\"")
Below is the extra fields of this scenario, please also check the base API fields. |
This page discuss the extended information for ride hailing scenarios, please also check the base API.
Order Status
Fields vs Order Status Mapping
Fields vs Order Status Mapping
Estimated duration for the driver to arrive the departure location in minutes.
Estimated duration for the driver to arrive the departure location in minutes.
","editType":"string","type":"string","warning":"","warningLake":""},{"name":"estimated_cost","description":"Estimated cost of the order in cents. (1 = $0.01, 100 = $1)
Estimated cost of the order in cents. (1 = $0.01, 100 = $1)
","editType":"string","type":"string","warning":"REQUIRED when ride_price_type == ESTIMATE and status is SERVING.
ride_price_type == ESTIMATE and status is SERVING.
Currency of estimated_cost.
Currency of estimated_cost.
REQUIRED when ride_price_type == ESTIMATE and status is SERVING.
ride_price_type == ESTIMATE and status is SERVING.
License plate of the vechicle.
License plate of the vechicle.
","editType":"string","type":"string","warning":"","warningLake":""},{"name":"reservation_time","description":"Reserved start time in unix timestamp.
Reserved start time in unix timestamp.
","editType":"number","type":"number","warning":"","warningLake":""},{"name":"ride_dest_duration","description":"Estimated duration for vehicle to arrive the destination in minutes.
Estimated duration for vehicle to arrive the destination in minutes.
","editType":"string","type":"string","warning":"","warningLake":""},{"name":"ride_price_type","description":"Type of price calculation.
METER: Calculate by actual price meter on the vehicle.ESTIMATE(default): Calculate by estimation.
Type of price calculation.
METER: Calculate by actual price meter on the vehicle.ESTIMATE(default): Calculate by estimation.
Time of the user drop off in yyyy-MM-dd HH:mm:ss.
Time of the user drop off in yyyy-MM-dd HH:mm:ss.
Start time of the order event in unix timestamp.
ORDER_TAKENstatus: when this order took by the driver.SERVINGstatus: when the journey begins.
Start time of the order event in unix timestamp.
ORDER_TAKENstatus: when this order took by the driver.SERVINGstatus: when the journey begins.
An object providing business dedicated display information of different locale.
zh_HK: Traditional Chineseen_US: English
An object providing business dedicated display information of different locale.
zh_HK: Traditional Chineseen_US: English
An URL to proceed when user clicks the button.
An URL to proceed when user clicks the button.
","editType":"string","type":"string","warning":"","warningLake":""},{"name":"auto_color","description":"Color of the vechicle.
Color of the vechicle.
","editType":"string","type":"string","warning":"","warningLake":""},{"name":"auto_model","description":"Model of the vechicle
Model of the vechicle
","editType":"string","type":"string","warning":"","warningLake":""},{"name":"order_Url","description":"An URL to redirect when user clicks the notification but not the button.
An URL to redirect when user clicks the notification but not the button.
","editType":"string","type":"string","warning":"","warningLake":""}]}]}],"response":[],"examples":[{"scene":[],"request":"{ \"requestId\": \"1757402176458\", \"merchantBizNo\": \"1757402176458\", \"orderStatus\": \"PENDING\", \"userId\": \"216022015977xxxx\", \"merchantBizType\": \"RIDE_HAILING\", \"orderCreateTime\": 1757402176458, \"orderModifyTime\": 1757402176458, \"tradeNo\": \"216022015977xxxx_1757402176458\", \"extInfo\": { \"service_start_time\": 1757402176458, \"service_end_time\": 1757403076458, \"reservation_time\": 1757402476458, \"license_plate\": \"ALIPAYHK\", \"driver_board_duration\": \"5\", \"ride_dest_duration\": \"10\", \"ride_price_type\": \"ESTIMATE\", \"estimated_cost_currency\": \"HKD\", \"estimated_cost\": \"3000\", \"multiLang\": { \"zh_HK\": { \"action_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"order_Url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"auto_color\": \"白色\", \"auto_model\": \"香港銅鑼灣勿地臣街 1 號\" }, \"en_US\": { \"action_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"order_Url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"auto_color\": \"White\", \"auto_model\": \"1 Matheson Street, Causeway Bay, Hong Kong\" } } }}"}],"exampleResponse":[]},"sceneConfig":[{"name":"APP","items":[{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*g-x4R5biJnsAAAAAAAAAAAAAARQnAQ","name":"ALIPAY","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*oWi6R65CbmgAAAAAAAAAAAAAARQnAQ","name":"ALIPAY_HK","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*BGsoRLcqPFAAAAAAAAAAAAAAARQnAQ","name":"GCASH","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*3gswS6s147sAAAAAAAAAAAAAARQnAQ","name":"DANA","width":70,"text":""},{"icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*aN3iTZOdEhgAAAAAAAAAAAAAARQnAQ","name":"KAKAO_PAY","width":70,"text":""}]},{"name":"CLIENT","direction":"row","items":[{"name":"APP","icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*sHjISq1PKn8AAAAAAAAAAAAAARQnAQ","width":40},{"name":"H5","icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*cOz7T50g1I0AAAAAAAAAAAAAARQnAQ","width":40},{"name":"DESKTOP","icon":"https://gw.alipayobjects.com/mdn/rms_b3f2c2/afts/img/A*NKaIRq-KfQYAAAAAAAAAAAAAARQnAQ","width":40}]},{"name":"MERCHANT","items":[{"name":"INST","text":"机构商户"},{"name":"DIRECT","text":"直联商户"}]},{"name":"GRANT_TYPE","items":[{"name":"AUTHORIZATION_CODE","text":"AUTHORIZATION_CODE"},{"name":"REFRESH_TOKEN","text":"REFRESH_TOKEN"}]},{"name":"CREATE_MEMBERSHIP_CARD","items":[{"name":"WITH_USER_INFO","text":"With user information"},{"name":"WITHOUT_USER_INFO","text":"Without user information"}]},{"name":"COLLECT_PMS_INFORMATION","items":[{"name":"MERCHANT_PMS","text":"MERCHANT_PMS"},{"name":"IPAY_TRADE_NO","text":"IPAY_TRADE_NO"}]},{"name":"Card Type","items":[{"name":"COUPON","text":"COUPON"},{"name":"TICKET","text":"TICKET"}]},{"name":"Ticket Type","items":[{"name":"PASS","text":"PASS"},{"name":"TICKET_MOVIE","text":"MOVIE"},{"name":"AIR TICKET","text":"AIR TICKET"},{"name":"TRAIN TICKET","text":"TRAIN TICKET"},{"name":"BUS TICKET","text":"BUS TICKET"},{"name":"SHIP TICKET","text":"SHIP TICKET"}]},{"name":"Display Code Type","items":[{"name":"BARCODE","text":"BARCODE"},{"name":"QR CODE","text":"QR CODE"},{"name":"PROMO CODE","text":"PROMO CODE"},{"name":"NONE","text":"NONE"}]},{"name":"Card Status","items":[{"name":"USED","text":"USED"},{"name":"CLOSED","text":"CLOSED"},{"name":"UPDATE","text":"UPDATE"},{"name":"REFUND","text":"REFUND"}]},{"name":"內容入庫","items":[{"name":"Catering (BRAND)","text":"Catering (BRAND)"},{"name":"Catering (STORE)","text":"Catering (STORE)"},{"name":"Movie (MOVIE)","text":"Movie (MOVIE)"},{"name":"E-Commerce (STORE)","text":"E-Commerce (STORE)"},{"name":"E-Commerce (SKU)","text":"E-Commerce (SKU)"},{"name":"Telecom (SKU)","text":"Telecom (SKU)"},{"name":"Medical (SKU)","text":"Medical (SKU)"},{"name":"Redeemable Card (GIFT_CARD)","text":"Redeemable Card (GIFT_CARD)"},{"name":"Admission Ticket (PASS)","text":"Admission Ticket (PASS)"}]},{"name":"订单中心","items":[{"name":"Gift Card","text":"Gift Card"},{"name":"Coupon with Code","text":"Coupon with Code"}]},{"name":"缴费","items":[{"name":"redirect to merchant","text":"redirect to merchant"},{"name":"order by alipay","text":"order by alipay"}]}]}