AlipayHKAlipayHKDOCS

How can we help?

Train Ticket

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

This page discuss the extended information for specific scenario, please also check the base API.

Order Status

\"image.png\"

Order Status

Description

Notification Logic

TICKETED

When the ticket is issued.

Issue ticket in Card Wallet.

REFUNDED

(End status)

When the order is refunded.

Hide performance notification.

Ticket will disappear.

USED

(End status)

When the ticket is used.

Hide performance notification.

Ticket status change to USED.


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

","descriptionLake":"

This page discuss the extended information for specific scenario, please also check the base API.

Order Status


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

The original amount of this ticket.

","descriptionLake":"

The original amount of this ticket.

","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},{"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":"payAmount","description":"

The actual amount user paid.

","descriptionLake":"

The actual amount user paid.

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

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

","descriptionLake":"

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

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

Merchant's order ID.

","descriptionLake":"

Merchant's order ID.

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

An object controls the display code value.

","descriptionLake":"

An object controls the display code value.

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

Use passengerInfoList if number of passenger > 1, and place any strings in this object.

","warningLake":"

Use passengerInfoList if number of passenger > 1, and place any strings in this object.

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

Message of the display code.

","descriptionLake":"

Message of the display code.

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

Value of the display code.

","descriptionLake":"

Value of the display code.

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

A template code ID provided by AlipayHK.

","descriptionLake":"

A template code ID provided by AlipayHK.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

"},{"name":"available_time","description":"

Notification / Ticket display start datetime to the user in milliseconds.

","descriptionLake":"

Notification / Ticket display start datetime to the user in milliseconds.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

"},{"name":"expired_time","description":"

Notification / Ticket display end datetime of this ticket in milliseconds.

","descriptionLake":"

Notification / Ticket display end datetime of this ticket in milliseconds.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

"},{"name":"start_time","description":"

Start datetime of this event in milliseconds.

","descriptionLake":"

Start datetime of this event in milliseconds.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

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

End datetime of this event in milliseconds.

","descriptionLake":"

End datetime of this event in milliseconds.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

"},{"name":"from_timezone","description":"

Time zone of the departure station, i.e. GMT+8.

","descriptionLake":"

Time zone of the departure station, i.e. GMT+8.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

"},{"name":"to_timezone","description":"

Time zone of the arrival station, i.e. GMT+6.

","descriptionLake":"

Time zone of the arrival station, i.e. GMT+6.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

"},{"name":"shiftNumber","description":"

The train reporting number.

","descriptionLake":"

The train reporting number.

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

REQUIRED when status is TICKETED.

","warningLake":"

when status is TICKETED.

"},{"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":"from","description":"

Name of the departure station.

","descriptionLake":"

Name of the departure station.

","editType":"string","type":"string","warning":"","warningLake":"","required":true,"maxLength":48},{"name":"to","description":"

Name of the arrival station.

","descriptionLake":"

Name of the arrival station.

","editType":"string","type":"string","warning":"","warningLake":"","required":true,"maxLength":48},{"name":"checkpoint","description":"

List of the departure gates, i.e.​ [\"1A\",\"1B\"]​

","descriptionLake":"

List of the departure gates, i.e. ["1A","1B"]

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

List of passengers' ticket information.

","descriptionLake":"

List of passengers' ticket information.

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

The ID of this passenger's ticket.

","descriptionLake":"

The ID of this passenger's ticket.

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

The masked ID number of this passenger.

","descriptionLake":"

The masked ID number of this passenger.

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

Status of this ticket.

  • ​AVAILABLE​: The pass is available to use.
  • ​​​USED​: The pass is used (will move to used page in the wallet).
  • ​CLOSED​: Remove this pass completely from the wallet.
","descriptionLake":"

Status of this ticket.

  • AVAILABLE: The pass is available to use.
  • USED: The pass is used (will move to used page in the wallet).
  • CLOSED: Remove this pass completely from the wallet.
","editType":"string","type":"string","warning":"","warningLake":"","required":true},{"name":"passengerName","description":"

Name of the passenger.

","descriptionLake":"

Name of the passenger.

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

Type of this ticket.

","descriptionLake":"

Type of this ticket.

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

Service level of this ticket.

","descriptionLake":"

Service level of this ticket.

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

Seat number of the passenger.

","descriptionLake":"

Seat number of the passenger.

","editType":"string","type":"string","warning":"","warningLake":""}],"maxSize":15},{"name":"platform_name","description":"

Name of the platform / agency.

","descriptionLake":"

Name of the platform / agency.

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

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

","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, \"from_timezone\": \"GMT+8\", \"to_timezone\": \"GMT+8\", \"shiftNumber\": \"A12345\", \"multiLang\": { \"zh_HK\": { \"from\": \"香港西九龍\", \"to\": \"深圳北\", \"checkpoint\": [ \"1A\", \"1B\" ], \"passengerInfoList\": [ { \"id\": \"11111111\", \"passengerName\": \"王XX\", \"idNumber\": \"H*******1134\", \"seatNum\": \"09车03D号\", \"ticketType\": \"成人票\", \"ticketLevel\": \"商务座\", \"status\": \"AVAILABLE\", \"codeInfo\": { \"codeMsg\": \"ticket code\", \"codeValue\": \"AABB345OODD\", \"codeType\": \"qrcode\", \"codeStandard\": \"QRCODE\" } } ], \"platform_name\": \"AlipayHK\", \"platform_logo\": \"https://mdn.alipayobjects.com/huamei_xfceij/afts/img/A*Wbi4SpWwX_IAAAAAAAAAAAAADgeDAQ/original\" }, \"en_US\": { \"from\": \"Hong Kong West Kowloon\", \"to\": \"Shenzhen North \", \"checkpoint\": [ \"1A\", \"1B\" ], \"passengerInfoList\": [ { \"id\": \"11111111\", \"passengerName\": \"Wang XXX XXX\", \"idNumber\": \"H*******1134\", \"seatNum\": \"09 Car 03D\", \"ticketType\": \"Adult\", \"ticketLevel\": \"Business\", \"status\": \"AVAILABLE\", \"codeInfo\": { \"codeMsg\": \"ticket code\", \"codeValue\": \"AABB345OODD\", \"codeType\": \"qrcode\", \"codeStandard\": \"QRCODE\" } } ], \"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"}]}]}