AlipayHKAlipayHKDOCS

How can we help?

Self Pick

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

This page discuss the extended information for self pick up scenarios, please also check the base API.

Order Status

Notification can start from any status below and status can be skipped if necessary, but not in reverse.

Order Status

Description

Display Sample (Index Page)

PENDING

When the restaurant has not confirmed the order.

\"image.png\"

ORDER_TAKEN

When the order is confirmed by the restaurant.

\"image.png\"

TO_PICK_UP

When the order is ready to pick up.

\"image.png\"

FINISHED

When the order is picked up.

Hide notification.

CLOSED

When the order is cancelled.

Hide notification.

REFUNDED

When the order is refunded.

\"image.png\"

Hide notification after 10 mins.


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

","descriptionLake":"

This page discuss the extended information for self pick up scenarios, please also check the base API.

Order Status


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


","moreLake":"


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

The total amount of this order.

","descriptionLake":"

The total amount of this order.

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"value","description":"

Value in cents.

","descriptionLake":"

Value in cents.

","editType":"string","type":"string","warning":"","warningLake":"","required":true,"maxLength":64},{"name":"currency","description":"

A 3-letter ISO 4217 currency code, i.e. HKD

","descriptionLake":"

A 3-letter ISO 4217 currency code, i.e. HKD

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

The discount amount of this order.

","descriptionLake":"

The discount amount of this order.

","editType":"object","type":"object","warning":"","warningLake":"","kvs":[{"name":"value","description":"

Value in cents.

","descriptionLake":"

Value in cents.

","editType":"string","type":"string","warning":"","warningLake":"","required":true,"maxLength":64},{"name":"currency","description":"

A 3-letter ISO 4217 currency code, i.e. HKD

","descriptionLake":"

A 3-letter ISO 4217 currency code, i.e. HKD

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

The actual amount of this order.

","descriptionLake":"

The actual amount of this order.

","editType":"object","type":"object","warning":"","warningLake":"","kvs":[{"name":"value","description":"

Value in cents.

","descriptionLake":"

Value in cents.

","editType":"string","type":"string","warning":"","warningLake":"","required":true,"maxLength":64},{"name":"currency","description":"

A 3-letter ISO 4217 currency code, i.e. HKD

","descriptionLake":"

A 3-letter ISO 4217 currency code, i.e. HKD

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

The transaction number provided by Alipay.

","descriptionLake":"

The transaction number provided by Alipay.

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

List of items in this order.

","descriptionLake":"

List of items in this order.

","editType":"object","type":"Array","warning":"","warningLake":"","required":true,"kvs":[{"name":"itemId","description":"

SKU ID reference of this item.

","descriptionLake":"

SKU ID reference of this item.

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

Quantity of this item to the nearest 2 decimals.

","descriptionLake":"

Quantity of this item to the nearest 2 decimals.

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

Unit price of this item.

","descriptionLake":"

Unit price of this item.

","editType":"object","type":"object","warning":"","warningLake":"","kvs":[{"name":"value","description":"

Value in cents.

","descriptionLake":"

Value in cents.

","editType":"string","type":"string","warning":"","warningLake":"","maxLength":64},{"name":"currency","description":"

A 3-letter ISO 4217 currency code, i.e. HKD

","descriptionLake":"

A 3-letter ISO 4217 currency code, i.e. HKD

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

Extended information of this shop.

","descriptionLake":"

Extended information of this shop.

","editType":"object","type":"object","warning":"","warningLake":"","kvs":[{"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":"itemName","description":"

Display name of this item.

","descriptionLake":"

Display name of this item.

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

Display unit of this item.

","descriptionLake":"

Display unit of this item.

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

Information of the shop.

","descriptionLake":"

Information of the shop.

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"extInfo","description":"

Extended information of this shop.

","descriptionLake":"

Extended information of this shop.

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"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":"name","description":"

Display name of this shop.

","descriptionLake":"

Display name of this shop.

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

Display address of this shop.

","descriptionLake":"

Display address of this shop.

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

An URL redirects to the shop, starts with allpayhk://.

","descriptionLake":"

An URL redirects to the shop, starts with allpayhk://.

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

Extended information of this service order.

","descriptionLake":"

Extended information of this service order.

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"pick_up_code_type","description":"

Type of the pick up code.

  • SELF_PICK_CODE: Pick up code.
","descriptionLake":"

Type of the pick up code.

  • SELF_PICK_CODE: Pick up code.
","editType":"string","type":"string","warning":"","warningLake":"","required":true},{"name":"pick_up_code","description":"

Pick up code of this order.

","descriptionLake":"

Pick up code of this order.

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

Start of available pick up time in milliseconds.

","descriptionLake":"

Start of available pick up time in milliseconds.

","editType":"number","type":"number","warning":"","warningLake":"","required":true},{"name":"pick_up_end_time","description":"

Due datetime of the pick up in milliseconds.

","descriptionLake":"

Due datetime of the pick up in milliseconds.

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

An URL redirects to the reorder page, starts with allpayhk://.

","descriptionLake":"

An URL redirects to the reorder page, starts with allpayhk://.

","editType":"string","type":"string","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":"pick_up_shop","description":"

Name of the pick up shop or location.

","descriptionLake":"

Name of the pick up shop or location.

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

Address of the pick up location.

","descriptionLake":"

Address of the pick up location.

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

An URL redirects to the details of this service order, starts with allpayhk://.

","descriptionLake":"

An URL redirects to the details of this service order, starts with allpayhk://.

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

Display merchant name on the card (title).

","descriptionLake":"

Display merchant name on the card (title).

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

An URL reference the display merchant icon (72 x 72px) on the card, starts with ​https://​

","descriptionLake":"

An URL reference the display merchant icon (72 x 72px) on the card, starts with https://

","editType":"string","type":"string","range":"<100 KB","warning":"","warningLake":"","required":true}]}]}],"response":[],"examples":[{"scene":[],"request":"{ \"amount\": { \"value\": \"10000\", \"currency\": \"HKD\" }, \"discountAmount\": { \"value\": \"2000\", \"currency\": \"HKD\" }, \"actualAmount\": { \"value\": \"8000\", \"currency\": \"HKD\" }, \"tradeNo\": \"2123094382159431592739568123\", \"itemOrderList\": [ { \"itemId\": \"item1\", \"quantity\": \"1\", \"unitPrice\": { \"value\": \"4000\", \"currency\": \"HKD\" }, \"extInfo\": { \"multiLang\": { \"zh_HK\": { \"itemName\": \"港式奶茶\", \"unit\": \"杯\" }, \"en_US\": { \"itemName\": \"HK Milk Tea\", \"unit\": \"Cup\" } } } } ], \"shopInfo\": { \"extInfo\": { \"multiLang\": { \"zh_HK\": { \"name\": \"飛豬茶餐廳（銅鑼灣店）\", \"address\": \"香港銅鑼灣勿地臣街 1 號\", \"merchantShopLinkPage\": \"alipayhk://platformapi/startapp?appId=2102020144263434&page=package_store%2Fpages%2Fstore%2Fstore%3Fstore_id%3D5430\" }, \"en_US\": { \"name\": \"Fliggy Cafe (CWB)\", \"address\": \"1 Matheson Street, Causeway Bay, Hong Kong\", \"merchantShopLinkPage\": \"alipayhk://platformapi/startapp?appId=2102020144263434&page=package_store%2Fpages%2Fstore%2Fstore%3Fstore_id%3D5430\" } } } }, \"extInfo\": { \"pick_up_code_type\": \"SELF_PICK_CODE\", \"pick_up_code\": \"P2046\", \"pick_up_start_time\": 1737619511127, \"come_again_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"multiLang\": { \"zh_HK\": { \"order_detail_link_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"pick_up_shop\": \"香港支付寶中心\", \"pick_up_address\": \"香港銅鑼灣勿地臣街 1 號\", \"show_merchant_name\": \"香港支付寶\", \"show_merchant_icon_url\": \"https://mdn.alipayobjects.com/huamei_xfceij/afts/img/A*Wbi4SpWwX_IAAAAAAAAAAAAADgeDAQ/original\" }, \"en_US\": { \"order_detail_link_url\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"pick_up_shop\": \"AlipayHK Center\", \"pick_up_address\": \"1 Matheson Street, Causeway Bay, Hong Kong\", \"show_merchant_name\": \"AlipayHK\", \"show_merchant_icon_url\": \"https://mdn.alipayobjects.com/huamei_xfceij/afts/img/A*Wbi4SpWwX_IAAAAAAAAAAAAADgeDAQ/original\" } } }}"}],"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":"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"}]}]}