Ride Hailing
This page discuss the extended information for payment order scenarios, please also check the base API.
Order Status
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. |
**Display time = driver_board_duration - current system timestamp - service_start_time **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. |
Below shows the languageBusinessInfo of this scenario.
Fields are with respect to different order status, please check the mapping below. |
Request parameters
action_url Array<string>
An URL to proceed when user clicks the button.
auto_color string
Color of the vechicle.
auto_model string
Model of the vechicle
driver_board_duration string
Estimated duration for the driver to arrive the departure location in minutes.
estimated_cost Array<string>
Estimated cost of the order in cents. (1 = $0.01, 100 = $1)
when
ride_price_type ==ESTIMATEand status is SERVING.
estimated_cost_currency string
Currency of estimated_cost.
when
ride_price_type==ESTIMATEand status isSERVING.
license_plate string
License plate of the vechicle.
order_Url string
An URL to redirect when user clicks the notification but not the button.
reservation_time string
Reserved start time in yyyy-MM-dd HH:mm:ss.
ride_dest_duration string
Estimated duration for vehicle to arrive the destination in minutes.
ride_price_type string
Type of price calculation.
METER: Calculate by actual price meter on the vehicle.ESTIMATE(default): Calculate by estimation.
service_end_time string
Time of the user drop off in yyyy-MM-dd HH:mm:ss.
service_start_time string
Start time of the order event in yyyy-MM-dd HH:mm:ss.
-
ORDER_TAKEN status: when this order took by the driver. -
SERVING status: when the journey begins.