How can we help?

{"content":{"bizType":"NOTIFICATION","endpoint":"/api/open/alipay/v1/merchant/order/sync","hideEndpoint":false,"description":"","descriptionLake":"

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

Order Status

","result":[{"code":"SUCCESS","value":"S","message":"success","action":"","actionLake":"

success

"},{"code":"PARAM_ILLEGAL","value":"F","message":"Request is invalid, usually missing parameters.","action":"","actionLake":""},{"code":"ORDER_STATUS_INVALID","value":"F","message":"The order status is illegal. The status is not matched or the state machine does not support changes to this status","action":"","actionLake":""},{"code":"UNKNOWN_EXCEPTION","value":"U","message":"Unknown error. Merchants can try later first & contact with AlipayHK","action":"","actionLake":""},{"code":"UN_SUPPORT_BUSINESS","value":"F","message":"The service is not supported. eg: The merchant is not onboard & the API is offline","action":"","actionLake":""}],"moreCodes":[],"request":[{"name":"tradeNo","description":"","descriptionLake":"

The transaction number provided by Alipay.

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

The original amount of this order.

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

Value in cents.

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

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

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

The actual amount user paid for this order.

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

Value in cents.

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

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

","editType":"string","type":"string","warning":"","warningLake":"","required":true}]},{"name":"extInfo","description":"","descriptionLake":"","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[{"name":"benefit_issue_mode","description":"","descriptionLake":"

Type of issue mode.

• Gift card: SALE

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

Activity ID, obtained offline from AlipayHK.

","editType":"string","type":"string","warning":"","warningLake":"","required":true}]}],"response":[{"name":"result","description":"","descriptionLake":"

Result of response

","editType":"object","type":"object","warning":"","warningLake":"","required":true,"kvs":[]},{"name":"orderId","description":"","descriptionLake":"

The order ID from AlipayHK

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

Refer 'Order Status' tab above.

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

Business result

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

Gift Card ID

","descriptionLake":"

Gift Card ID

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

URL reference to the details of this gift card, starts with alipayhk://.

","descriptionLake":"

URL reference to the details of this gift card, starts with alipayhk://.

","editType":"string","type":"string","warning":"","warningLake":"","required":true}]}]}],"examples":[{"scene":["Gift Card"],"request":"{ \"requestId\": \"00242206688873156335287814888550\", \"merchantId\": \"2160120041113167\", \"merchantBizNo\": \"00242206688873156335287814888550\", \"orderStatus\": \"TICKETED\", \"userId\": \"2160220041431868\", \"merchantBizType\": \"ALIPAY_COUPON\", \"orderCreateTime\": 1740385506708, \"orderModifyTime\": 1742977506708, \"tradeNo\": \"Gift_card_tradeNo\", \"extInfo\": { \"benefit_issue_mode\": \"SALE\", \"product_id\": \"22025021800135606000000001663483\" }}"}],"exampleResponse":[{"scene":[],"response":"{ \"orderId\": \"2220100101001\", \"orderStatus\": \"TICKETED\", \"distributeResult\": [ { \"sceneCode\": \"PASS\", \"extInfo\": { \"benefitId\": \"2025030319050111540490000000000160270060891449\", \"detailLink\": \"alipayhk://platformapi/startapp?appId=85260012&scene=detail&id=2025030319050111540490000000000160270060891449\" } } ], \"result\": { \"resultCode\": \"SUCCESS\", \"resultMessage\": \"execute success\", \"resultStatus\": \"S\" }}"}]},"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"}]},{"name":"內容入庫","items":[{"name":"Catering (BRAND)","text":"Catering (BRAND)"},{"name":"Catering (STORE)","text":"Catering (STORE)"},{"name":"MOVIE","text":"MOVIE"},{"name":"E-Commerce (STORE)","text":"E-Commerce (STORE)"},{"name":"E-Commerce (SKU)","text":"E-Commerce (SKU)"},{"name":"Telecom (SKU)","text":"Telecom (SKU)"}]},{"name":"订单中心","items":[{"name":"Gift Card","text":"Gift Card"}]}]}