AlipayHKAlipayHKDOCS

How can we help?

Ride Hailing

{"content":{"bizType":"NOTIFICATION","endpoint":"api/open/alipay/intl/promotion/order/contractCardSync","hideEndpoint":true,"description":"

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.png\"\"image.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.png\"\"image.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.png\"\"image.png\"**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.

\"image.png\"\"image.png\"

SERVING

When the journey begins.

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

\"image.png\"\"image.png\"

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

WAIT_PAY

When the user has to pay.

\"image.png\"\"image.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.png\"\"image.png\"

CLOSED

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

\"image.png\"\"image.png\"


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

","descriptionLake":"

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

Order Status


","titleTag":"","result":[],"more":"

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


✅

✅


to_address

✅

✅

✅

✅

✅

✅

✅

✅



","moreLake":"

Fields vs Order Status Mapping

✅ fields are required for the relevant status.


","moreCodes":[],"request":[{"name":"extInfo","description":"

Extend information of this order.

","descriptionLake":"

Extend information of this order.

","editType":"object","type":"object","warning":"

Please check the require fields mapping in the table below.

","warningLake":"

Please check the require fields mapping in the table below.

","required":true,"kvs":[{"name":"currency","description":"

Currency of ​pay_amount​.

","descriptionLake":"

Currency of pay_amount.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"driver_board_distance","description":"

Estimated distance for the driver to arrive the departure location in metres.

","descriptionLake":"

Estimated distance for the driver to arrive the departure location in metres.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"driver_board_duration","description":"

Estimated duration for the driver to arrive the departure location in minutes.

","descriptionLake":"

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)

","descriptionLake":"

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​.

","warningLake":"

 when ride_price_type == ESTIMATE and status is SERVING.

"},{"name":"estimated_cost_currency","description":"

Currency of ​estimated_cost​.

","descriptionLake":"

Currency of estimated_cost.

","editType":"string","type":"string","warning":"

REQUIRED when ride_price_type == ESTIMATE and status is SERVING.

","warningLake":"

 when ride_price_type == ESTIMATE and status is SERVING.

"},{"name":"license_plate","description":"

License plate of the vechicle.

","descriptionLake":"

License plate of the vechicle.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"pay_amount","description":"

The amount which user needs to pay in cents. (1 = $0.01, 100 = $1)

","descriptionLake":"

The amount which user needs to pay in cents. (1 = $0.01, 100 = $1)

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"reservation_time","description":"

Reserved start time in milliseconds.

","descriptionLake":"

Reserved start time in milliseconds.

","editType":"number","type":"number","warning":"","warningLake":""},{"name":"ride_dest_distance","description":"

Estimated distince for vehicle to arrive the destination in metres.

","descriptionLake":"

Estimated distince for vehicle to arrive the destination in metres.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"ride_dest_duration","description":"

Estimated duration for vehicle to arrive the destination in minutes.

","descriptionLake":"

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.
","descriptionLake":"

Type of price calculation.

  • METER: Calculate by actual price meter on the vehicle.
  • ESTIMATE (default): Calculate by estimation.
","editType":"string","type":"string","warning":"","warningLake":""},{"name":"service_end_time","description":"

Time of the user drop off in milliseconds.

","descriptionLake":"

Time of the user drop off in milliseconds.

","editType":"number","type":"number","warning":"","warningLake":""},{"name":"service_start_time","description":"

Start time of the order event in milliseconds.

  • ORDER_TAKEN status: when this order took by the driver.
  • SERVING status: when the journey begins.
","descriptionLake":"

Start time of the order event in milliseconds. 

  • ORDER_TAKEN status: when this order took by the driver.
  • SERVING status: when the journey begins.
","editType":"number","type":"number","warning":"","warningLake":""},{"name":"multiLang","description":"

An object providing business dedicated display information of different locale.

  • zh_HK: Traditional Chinese
  • en_US: English
","descriptionLake":"

An object providing business dedicated display information of different locale.

  • zh_HK: Traditional Chinese
  • en_US: English
","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"action_url","description":"

An URL to proceed when user clicks the button.

","descriptionLake":"

An URL to proceed when user clicks the button.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"auto_color","description":"

Color of the vechicle.

","descriptionLake":"

Color of the vechicle.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"auto_model","description":"

Model of the vechicle

","descriptionLake":"

Model of the vechicle

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"from_address","description":"

The onboarding address of this order.

","descriptionLake":"

The onboarding address of this order.

","editType":"string","type":"string","warning":"","warningLake":"","required":true},{"name":"to_address","description":"

The destination of this order.

","descriptionLake":"

The destination of this order.

","editType":"string","type":"string","warning":"","warningLake":"","required":true},{"name":"order_Url","description":"

An URL to redirect when user clicks the notification but not the button.

","descriptionLake":"

An URL to redirect when user clicks the notification but not the button.

","editType":"string","type":"string","warning":"","warningLake":""}]}]}],"response":[],"examples":[{"scene":[],"request":"{ \"requestId\": \"1757560850882\", \"merchantBizNo\": \"1757560850882\", \"orderStatus\": \"PENDING\", \"userId\": \"2160220159774396\", \"merchantBizType\": \"RIDE_HAILING\", \"orderCreateTime\": 1757560850882, \"orderModifyTime\": 1757560850882, \"tradeNo\": \"2160220159774396_1757560850882\", \"extInfo\": { \"service_start_time\": 1757560850882, \"service_end_time\": 1757561750882, \"reservation_time\": 1757561150882, \"license_plate\": \"ALIPAYHK\", \"driver_board_duration\": \"5\", \"driver_board_distance\": \"300\", \"ride_dest_duration\": \"10\", \"ride_dest_distance\": \"1500\", \"ride_price_type\": \"ESTIMATE\", \"estimated_cost_currency\": \"HKD\", \"estimated_cost\": \"3000\", \"currency\": \"HKD\", \"pay_amount\": \"2500\", \"multiLang\": { \"zh_HK\": { \"action_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"order_Url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"auto_color\": \"白色\", \"auto_model\": \"X\", \"from_address\": \"香港銅鑼灣勿地臣街 1 號\", \"to_address\": \"中環金融街 8 號\" }, \"en_US\": { \"action_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"order_Url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"auto_color\": \"White\", \"auto_model\": \"X\", \"from_address\": \"1 Matheson Street, Causeway Bay, Hong Kong\", \"to_address\": \"8 Finance Street, Central, 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"}]}]}