How can we help?

{"content":{"bizType":"NOTIFICATION","endpoint":"/api/open/alipay/v1/ipass/pass/manage/createPass","hideEndpoint":true,"description":"","descriptionLake":"

This page discuss the extended information for admission ticket scenarios, please also check the base API.

Order Status

","result":[],"moreCodes":[],"request":[{"name":"tradeNo","description":"","descriptionLake":"

The transaction number provided by Alipay.

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

The 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":"surcharge_amount","description":"","descriptionLake":"

Service surcharge for exceeding charging / parking time limits.

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

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

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

Merchant's order ID.

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

The current charging progress in %, i.e. 70 for 70%.

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

The max progress of charging.

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

Start datetime of this event in milliseconds.

","editType":"number","type":"number","warning":"","warningLake":"

when status is not FINISHED.

"},{"name":"end_time","description":"","descriptionLake":"

End datetime of this event in milliseconds.

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

The period of EV being charged in minutes.

","editType":"string","type":"string","warning":"","warningLake":""},{"name":"multiLang","description":"","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":"platform_name","description":"","descriptionLake":"

Name of the platform / agency.

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

An URL redirects to the logo of the platform / agency.

","editType":"string","type":"string","range":"<100 KB","warning":"","warningLake":"","maxLength":256}]}]}],"response":[],"examples":[{"scene":[],"request":"{ \"amount\": { \"value\": \"10000\", \"currency\": \"HKD\" }, \"payAmount\": { \"value\": \"2000\", \"currency\": \"HKD\" }, \"tradeNo\": \"2123094382159431592739568123\", \"extInfo\": { \"merchant_bill_detail\": \"alipayhk://platformapi/startapp?appId=2102000032500019\", \"merchant_bill_id\": \"P2046\", \"codeInfo\": { \"code_msg\": \"codeInfo\", \"code_value\": \"codeInfo\" }, \"template_code\": \"22025030300135606000000015385502\", \"available_time\": 1740998266927, \"expired_time\": 1741001866927, \"start_time\": 1740998266927, \"end_time\": 1741001866927, \"available_times\": 1, \"multiLang\": { \"zh_HK\": { \"address\": \"香港銅鑼灣勿地臣街 1 號\", \"platform_name\": \"AlipayHK\", \"platform_logo\": \"https://mdn.alipayobjects.com/huamei_xfceij/afts/img/A*Wbi4SpWwX_IAAAAAAAAAAAAADgeDAQ/original\" }, \"en_US\": { \"address\": \"1 Matheson Street, Causeway Bay, Hong Kong\", \"platform_name\": \"AlipayHK\", \"platform_logo\": \"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":"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"}]}]}