AlipayHKAlipayHKDOCS

Ride Hailing

This page discuss the extended information for ride hailing scenarios, please also check the base API.

Order Status

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.

image.pngimage.png

BOOKED

When the vehicle is booked but the driver has not started coming to pick-up.

**This status is for pre-book vehicle only.

image.pngimage.png

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.

image.pngimage.png**Display time = driver_board_duration - (current system timestamp - service_start_time) / 60000

**Progress = (current system timestamp - service_start_time) / driver_board_duration

TO_BOARD

When the user has to board.

image.pngimage.png

SERVING

When the journey begins.

Progress bar is calculated by service_start_time, ride_dest_duration and current system timestamp.

image.pngimage.png

**Progress = (current system timestamp - service_start_time) / ride_dest_duration

WAIT_PAY

When the user has to pay.

image.pngimage.png

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.

image.pngimage.png

CLOSED

When the order is cancelled by the driver, notification will disappear after 5 mins.

image.pngimage.png


Below is the extra fields of this scenario, please also check the base API fields.

Request parameters

extInfo object  REQUIRED

Extend information of this order.

Please check the require fields mapping in the table below.

Show child parameters

Response parameters

No request parameters.
API Explorer

Request

Request Body

Response

Response Body

Fields vs Order Status Mapping

✅ fields are required for the relevant status.

Order Status

PENDING

BOOKED

ORDER_

TAKEN

TO_

BOARD

SERVING

WAIT_

PAY

TO_

SEND

CLOSED

FINISHED

Field Name





action_url

✅

✅

✅

✅

✅

✅


auto_color


✅

✅


auto_model


✅

✅

✅


currency






✅




driver_board_distance










driver_board_duration


✅


estimated_cost


✅


estimated_cost_currency


✅


from_address

✅

✅

✅

✅

✅

✅

✅

✅


license_plate

✅

✅

✅


order_Url

✅

✅

✅

✅

✅

✅

✅

✅


pay_amount






✅




reservation_time


✅








ride_dest_distance










ride_dest_duration


✅


service_end_time


✅


service_start_time


✅

✅


time_zone


✅

✅



✅




to_address

✅

✅

✅

✅

✅

✅

✅

✅